機械翻訳について

移動

• リクエスト
• レスポンス

リクエストへのデータのプッシュ

patch

/api/v1/bots/{botId}/dynamicEntities/{entityId}/pushRequests/{pushRequestId}/values

エンティティ値を追加、削除および変更するためのオープンなプッシュ・リクエストを提供します。

この操作を使用すると、データをファイナライズまたは中断するまで、オープン(INPROGRESS)プッシュ・リクエストにプッシュできます。

リクエスト

パス・パラメータ

• botId(required): string
  エンティティを含むスキルのID。
• entityId(required): string
  更新するエンティティのID。
• pushRequestId(required): string
  リクエスト本文に指定された変更を実行するプッシュ・リクエストのID。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

追加、削除および変更するデータ。

ルート・スキーマ : schema

型: object

追加、削除および変更するデータ。

Show Source

• add: array add
  追加するエンティティ値。
• delete: array delete
  削除するエンティティ値。 プッシュ・リクエストのcopy問合せパラメータが省略されたか、FALSEに設定された場合、サービスはこのオブジェクトを無視します。
• modify: array modify
  変更するエンティティ値。 プッシュ・リクエストのcopy問合せパラメータが省略されたか、FALSEに設定された場合、サービスはこのオブジェクトを無視します。

{
    "type":"object",
    "properties":{
        "delete":{
            "type":"array",
            "description":"The entity values to delete. The service ignores this object if the <code>copy</code> query parameter for the push request was omitted or set to <code>FALSE</code>.",
            "items":{
                "$ref":"#/components/schemas/DynamicEntityPushTempEntityValue"
            }
        },
        "add":{
            "type":"array",
            "description":"The entity values to add.",
            "items":{
                "$ref":"#/components/schemas/DynamicEntityPushTempEntityValue"
            }
        },
        "modify":{
            "type":"array",
            "description":"The entity values to modify. The service ignores this object if the <code>copy</code> query parameter for the push request was omitted or set to <code>FALSE</code>.",
            "items":{
                "$ref":"#/components/schemas/DynamicEntityPushTempEntityValue"
            }
        }
    },
    "description":"The data to add, delete, and modify."
}

ネストされたスキーマ : add

型: array

追加するエンティティ値。

Show Source

• Array of: object DynamicEntityPushTempEntityValue
  エンティティ値とそのシノニム。

{
    "type":"array",
    "description":"The entity values to add.",
    "items":{
        "$ref":"#/components/schemas/DynamicEntityPushTempEntityValue"
    }
}

ネストされたスキーマ : delete

型: array

削除するエンティティ値。 プッシュ・リクエストのcopy問合せパラメータが省略されたか、FALSEに設定された場合、サービスはこのオブジェクトを無視します。

Show Source

• Array of: object DynamicEntityPushTempEntityValue
  エンティティ値とそのシノニム。

{
    "type":"array",
    "description":"The entity values to delete. The service ignores this object if the <code>copy</code> query parameter for the push request was omitted or set to <code>FALSE</code>.",
    "items":{
        "$ref":"#/components/schemas/DynamicEntityPushTempEntityValue"
    }
}

ネストされたスキーマ : 変更

型: array

変更するエンティティ値。 プッシュ・リクエストのcopy問合せパラメータが省略されたか、FALSEに設定された場合、サービスはこのオブジェクトを無視します。

Show Source

• Array of: object DynamicEntityPushTempEntityValue
  エンティティ値とそのシノニム。

{
    "type":"array",
    "description":"The entity values to modify. The service ignores this object if the <code>copy</code> query parameter for the push request was omitted or set to <code>FALSE</code>.",
    "items":{
        "$ref":"#/components/schemas/DynamicEntityPushTempEntityValue"
    }
}

ネストされたスキーマ : DynamicEntityPushTempEntityValue

型: object

エンティティ値とそのシノニム。

Show Source

• canonicalName(required): string
  エンティティ値。
• createdOn: string (date-time)
  読取り専用: true

  ISO 8601形式の日時で、リソースが作成された日時(例:2018-10-17T06:50:34.045Z)。
• id: string
  読取り専用: true

  リソースの一意のID。
• links: array links
  読取り専用: true

  リソースへのリンクの配列。
• nativeLanguageTag: string
  エンティティ値に使用するネイティブ言語タグ。 タグは、スキルがサポートするいずれかの言語を識別する必要があります。 このプロパティは、プライマリ言語のエントリであっても、ネイティブ複数言語のスキルに必要です。 このプロパティは、ネイティブの複数言語ではないスキルには無効です。
• primaryLanguageCanonicalName: string
  プライマリ言語のエンティティ値(canonicalName)。 このプロパティは、ネイティブ多言語スキルのセカンダリ言語エンティティ値に必要です。 プライマリ言語エンティティ値に含める場合は、canonicalName値と同じである必要があります。 ネイティブの複数言語ではないスキルには、このプロパティを含めないでください。
• synonyms: array synonyms
  エンティティ値のシノニム。
• updatedOn: string (date-time)
  読取り専用: true

  ISO 8601形式の日時で、リソースが最後に変更された日時(2018-10-17T06:50:34.045Zなど)。

{
    "required":[
        "canonicalName"
    ],
    "type":"object",
    "properties":{
        "createdOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was created (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "updatedOn":{
            "type":"string",
            "description":"The date and time, in ISO 8601 format, that the resource was last modified (for example, <code>2018-10-17T06:50:34.045Z</code>).",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "properties":{
                "selfLinks":{
                    "type":"object",
                    "properties":{
                        "absolutePathBuilder":{
                            "type":"object"
                        },
                        "baseUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUri":{
                            "type":"string",
                            "format":"uri"
                        },
                        "requestUriBuilder":{
                            "type":"object"
                        },
                        "baseUriBuilder":{
                            "type":"object"
                        },
                        "pathParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "queryParameters":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"array",
                                "items":{
                                    "type":"string"
                                }
                            }
                        },
                        "matchedURIs":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        },
                        "matchedResources":{
                            "type":"array",
                            "items":{
                                "type":"object"
                            }
                        },
                        "pathSegments":{
                            "type":"array",
                            "items":{
                                "type":"object",
                                "properties":{
                                    "matrixParameters":{
                                        "type":"object",
                                        "additionalProperties":{
                                            "type":"array",
                                            "items":{
                                                "type":"string"
                                            }
                                        }
                                    },
                                    "path":{
                                        "type":"string"
                                    }
                                }
                            }
                        },
                        "absolutePath":{
                            "type":"string",
                            "format":"uri"
                        },
                        "path":{
                            "type":"string"
                        }
                    },
                    "writeOnly":true
                },
                "empty":{
                    "type":"boolean"
                }
            },
            "description":"An array of links to the resource.",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "id":{
            "type":"string",
            "description":"The resource's unique ID.",
            "readOnly":true
        },
        "canonicalName":{
            "type":"string",
            "description":"The entity value."
        },
        "synonyms":{
            "type":"array",
            "description":"Synonyms for the entity value.",
            "items":{
                "type":"string",
                "description":"Synonyms for the entity value."
            }
        },
        "primaryLanguageCanonicalName":{
            "type":"string",
            "description":"The entity value (<code>canonicalName</code>) for the primary language. This property is required for secondary-language entity values for native multi-language skills. If you include it for a primary-language entity value, then it must be equal to the <code>canonicalName</code> value. The property must not be included for skills that aren't native multi-language."
        },
        "nativeLanguageTag":{
            "type":"string",
            "description":"The native language tag to use for the entity value. The tag must identify one of the languages that the skill supports. This property is required for native multi-language skills, even for entries for the primary language. This property is not valid for skills that aren't native multi-language."
        }
    },
    "description":"The entity value and its synonyms."
}

ネストされたスキーマ: links

型: array

読取り専用: true

リソースへのリンクの配列。

Show Source

• empty: boolean
• selfLinks: object selfLinks

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Show Source

• Array of: object Link

{
    "type":"array",
    "properties":{
        "selfLinks":{
            "type":"object",
            "properties":{
                "absolutePathBuilder":{
                    "type":"object"
                },
                "baseUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUri":{
                    "type":"string",
                    "format":"uri"
                },
                "requestUriBuilder":{
                    "type":"object"
                },
                "baseUriBuilder":{
                    "type":"object"
                },
                "pathParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "queryParameters":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "matchedURIs":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "matchedResources":{
                    "type":"array",
                    "items":{
                        "type":"object"
                    }
                },
                "pathSegments":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "matrixParameters":{
                                "type":"object",
                                "additionalProperties":{
                                    "type":"array",
                                    "items":{
                                        "type":"string"
                                    }
                                }
                            },
                            "path":{
                                "type":"string"
                            }
                        }
                    }
                },
                "absolutePath":{
                    "type":"string",
                    "format":"uri"
                },
                "path":{
                    "type":"string"
                }
            },
            "writeOnly":true
        },
        "empty":{
            "type":"boolean"
        }
    },
    "description":"An array of links to the resource.",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

ネストされたスキーマ : シノニム

型: array

エンティティ値のシノニム。

Show Source

• Array of: string
  エンティティ値のシノニム。

{
    "type":"array",
    "description":"Synonyms for the entity value.",
    "items":{
        "type":"string",
        "description":"Synonyms for the entity value."
    }
}

ネストされたスキーマ : selfLinks

型: object

Show Source

• absolutePath: string (uri)
• absolutePathBuilder: object absolutePathBuilder
• baseUri: string (uri)
• baseUriBuilder: object baseUriBuilder
• matchedResources: array matchedResources
• matchedURIs: array matchedURIs
• path: string
• pathParameters: object pathParameters
  許可される追加プロパティ: additionalProperties
• pathSegments: array pathSegments
• queryParameters: object queryParameters
  許可される追加プロパティ: additionalProperties
• requestUri: string (uri)
• requestUriBuilder: object requestUriBuilder

{
    "type":"object",
    "properties":{
        "absolutePathBuilder":{
            "type":"object"
        },
        "baseUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUri":{
            "type":"string",
            "format":"uri"
        },
        "requestUriBuilder":{
            "type":"object"
        },
        "baseUriBuilder":{
            "type":"object"
        },
        "pathParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "queryParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "matchedURIs":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "matchedResources":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "pathSegments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "matrixParameters":{
                        "type":"object",
                        "additionalProperties":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    },
                    "path":{
                        "type":"string"
                    }
                }
            }
        },
        "absolutePath":{
            "type":"string",
            "format":"uri"
        },
        "path":{
            "type":"string"
        }
    },
    "writeOnly":true
}

ネストされたスキーマ : リンク

型: object

Show Source

• href: string
  リソースのURL
• rel: string
  リソースとの関係

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"The relationship with the resource"
        },
        "href":{
            "type":"string",
            "description":"URL to the resource"
        }
    }
}

ネストされたスキーマ : absolutePathBuilder

型: object

ネストされたスキーマ : baseUriBuilder

型: object

ネストされたスキーマ : matchedResources

型: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

ネストされたスキーマ : matchedURIs

型: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : pathParameters

型: object

使用可能なその他のプロパティ

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : pathSegments

型: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "matrixParameters":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "path":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ : queryParameters

型: object

使用可能なその他のプロパティ

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : requestUriBuilder

型: object

ネストされたスキーマ: items

型: object

ネストされたスキーマ : additionalProperties

型: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: items

型: object

Show Source

• matrixParameters: object matrixParameters
  許可される追加プロパティ: additionalProperties
• path: string

{
    "type":"object",
    "properties":{
        "matrixParameters":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "path":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : matrixParameters

型: object

使用可能なその他のプロパティ

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : additionalProperties

型: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : additionalProperties

型: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

データがリクエストにプッシュされました。

404レスポンス

スキル、エンティティまたはプッシュ・リクエストが存在しないため、リクエストを実行できません。

本文()

ルート・スキーマ : RestError

型: object

Show Source

• detail: string
• instance: string
• o:ecid: string
• o:errorCode: string
• o:errorDetails: array o:errorDetails
• o:errorPath: string
• o:location: object Location
• o:opcRequestId: string
• status: integer (int32)
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

ネストされたスキーマ : ロケーション

型: object

Show Source

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ : コンテキスト

型: object

Show Source

• elementName: string
• elementType: string
  許容値: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  許容値: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

412レスポンス

リクエストがINPROGRESSではないため、リクエストにデータをプッシュできません。

本文()

ルート・スキーマ : RestError

型: object

Show Source

• detail: string
• instance: string
• o:ecid: string
• o:errorCode: string
• o:errorDetails: array o:errorDetails
• o:errorPath: string
• o:location: object Location
• o:opcRequestId: string
• status: integer (int32)
• title: string
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "o:ecid":{
            "type":"string"
        },
        "o:opcRequestId":{
            "type":"string"
        },
        "o:errorCode":{
            "type":"string"
        },
        "o:errorPath":{
            "type":"string"
        },
        "o:errorDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestError"
            }
        },
        "o:location":{
            "$ref":"#/components/schemas/Location"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

Show Source

• Array of: object RestError

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RestError"
    }
}

ネストされたスキーマ : ロケーション

型: object

Show Source

• context: object Context
• o:colNo: integer (int32)
• o:lineNo: integer (int32)
• source: string

{
    "type":"object",
    "properties":{
        "source":{
            "type":"string"
        },
        "context":{
            "$ref":"#/components/schemas/Context"
        },
        "o:lineNo":{
            "type":"integer",
            "format":"int32"
        },
        "o:colNo":{
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ : コンテキスト

型: object

Show Source

• elementName: string
• elementType: string
  許容値: [ "state", "defaultTransitionAction", "inputParameter", "outputParameter", "variable", "eventMapping", "intent", "entity" ]
• subElementName: string
• subElementType: string
  許容値: [ "stateProperty", "componentProperty", "transition", "transitionAction", "property", "inputParameter", "outputParameter" ]

{
    "type":"object",
    "properties":{
        "elementType":{
            "type":"string",
            "enum":[
                "state",
                "defaultTransitionAction",
                "inputParameter",
                "outputParameter",
                "variable",
                "eventMapping",
                "intent",
                "entity"
            ]
        },
        "elementName":{
            "type":"string"
        },
        "subElementType":{
            "type":"string",
            "enum":[
                "stateProperty",
                "componentProperty",
                "transition",
                "transitionAction",
                "property",
                "inputParameter",
                "outputParameter"
            ]
        },
        "subElementName":{
            "type":"string"
        }
    }
}

トップに戻る