Conversational Analysis Authoring - Import

リファレンス

サービス:: Azure AI Services

API バージョン:: 2022-05-01

プロジェクトをインポートするジョブをトリガーします。同じ名前のプロジェクトが既に存在する場合は、そのプロジェクトのデータが置き換えられます。

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2022-05-01

省略可能なパラメーターを含む:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-01

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	使用するプロジェクトの名前。
api-version	query	True	string	クライアント API のバージョン。
format	query		ExportedProjectFormat	使用するエクスポートされたプロジェクトファイルの形式。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string	言語サービスリソースのサブスクリプションキー。

要求本文

名前	必須	型	説明
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	プロジェクトのメタデータを表します。
projectFileVersion	True	string	エクスポートされたファイルのバージョン。
stringIndexType	True	StringIndexType	文字列オフセットの解釈に使用するメソッドを指定します。詳細については、https://aka.ms/text-analytics-offsetsを参照してください。
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	プロジェクト資産を表します。

応答

名前	型	説明
202 Accepted		呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。ヘッダー operation-location: string
Other Status Codes	ErrorResponse	エラー応答。

名前

型

説明

202 Accepted

呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。

ヘッダー

operation-location: string

Other Status Codes

ErrorResponse

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

言語サービスリソースのサブスクリプションキー。

型: apiKey
/: header

例

Successful Import Project

要求のサンプル

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-01


{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "EmailApp",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "en-us"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "Read"
      },
      {
        "category": "Delete"
      }
    ],
    "entities": [
      {
        "category": "Sender"
      }
    ],
    "utterances": [
      {
        "text": "Open Blake's email",
        "dataset": "Train",
        "intent": "Read",
        "entities": [
          {
            "category": "Sender",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "Delete last email",
        "language": "en-gb",
        "dataset": "Test",
        "intent": "Delete",
        "entities": []
      }
    ]
  }
}

応答のサンプル

状態コード:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

定義

名前	説明
CompositionSetting	エンティティのコンポーネントが互いに重なる場合に従う動作。
ConversationalAnalysisAuthoringConversationExportedEntity	エンティティとそのコンポーネントを表します。
ConversationalAnalysisAuthoringConversationExportedIntent	会話型プロジェクトのエクスポートされた意図を表します。
ConversationalAnalysisAuthoringConversationExportedProjectAssets	会話型プロジェクトのエクスポートされた資産を表します。
ConversationalAnalysisAuthoringConversationExportedUtterance	会話型プロジェクトのエクスポートされた発話を表します。
ConversationalAnalysisAuthoringCreateProjectOptions	プロジェクトの作成または更新に使用するオプションを表します。
ConversationalAnalysisAuthoringExportedConversationOrchestration	Conversational プロジェクトターゲットのオーケストレーションの詳細を定義します。
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	Conversational プロジェクトターゲットのオーケストレーションオプションを表します。
ConversationalAnalysisAuthoringExportedEntityList	エンティティのリストコンポーネントを表します。
ConversationalAnalysisAuthoringExportedEntityListSynonym	リストコンポーネント内のシノニムの一覧を表します
ConversationalAnalysisAuthoringExportedEntitySublist	リストコンポーネント内のサブリストを表します。
ConversationalAnalysisAuthoringExportedLuisOrchestration	LUIS アプリケーションターゲットのオーケストレーションの詳細を定義します。
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	LUIS アプリケーションターゲットのオーケストレーションオプションを表します。
ConversationalAnalysisAuthoringExportedPrebuiltEntity	エクスポートされた事前構築済みエンティティコンポーネントを表します
ConversationalAnalysisAuthoringExportedProject	エクスポートされたプロジェクトを表します。
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	Question Answering プロジェクトターゲットのオーケストレーションの詳細を定義します。
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	Question Answering プロジェクトターゲットのオーケストレーションオプションを表します。
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	発話のエンティティラベルを表します。
ConversationalAnalysisAuthoringOrchestrationExportedIntent	オーケストレーションプロジェクトのエクスポートされた意図を表します。
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	オーケストレーションプロジェクトの資産を表します。
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	オーケストレーションプロジェクトの発話を表します。
ConversationalAnalysisAuthoringProjectSettings	プロジェクトの動作を定義するために使用する設定を表します。
Error	エラーオブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
ExportedProjectFormat	使用するエクスポートされたプロジェクトファイルの形式。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	プロジェクトの種類を表します。
StringIndexType	文字列オフセットの解釈に使用するメソッドを指定します。詳細については、https://aka.ms/text-analytics-offsetsを参照してください。

CompositionSetting

列挙

エンティティのコンポーネントが互いに重なる場合に従う動作。

値	説明
combineComponents	テキスト内に複数のコンポーネントが見つかり、重なっている場合、コンポーネントのスパンは 1 つのスパンにまとめられ、それらのすべてが結合されます。
requireExactOverlap	すべてのコンポーネントは、返されるエンティティのテキスト内のまったく同じ文字で重なっている必要があります。定義されたコンポーネントのいずれかが一致または予測されていない場合、エンティティは返されません。
returnLongestOverlap	テキスト内に複数のコンポーネントが見つかり、重複している場合は、最も長い文字セットを持つコンポーネントが返されます。
separateComponents	すべてのコンポーネントの一致または予測は、エンティティの個別のインスタンスとして返されます。

ConversationalAnalysisAuthoringConversationExportedEntity

Object

エンティティとそのコンポーネントを表します。

名前	型	説明
category	string	エンティティのカテゴリ。
compositionSetting	CompositionSetting	エンティティのコンポーネントが互いに重なる場合に従う動作。
list	ConversationalAnalysisAuthoringExportedEntityList	エンティティのリストコンポーネント。
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	事前構築済みのエンティティコンポーネント。

ConversationalAnalysisAuthoringConversationExportedIntent

Object

会話型プロジェクトのエクスポートされた意図を表します。

名前	型	説明
category	string	意図カテゴリ。

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Object

会話型プロジェクトのエクスポートされた資産を表します。

名前	型	説明
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	プロジェクトで定義されているエンティティ。
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	プロジェクトで定義されている意図。
projectKind	string: Conversation	アセットを含むプロジェクトの種類。
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	プロジェクトで定義されている発話。

ConversationalAnalysisAuthoringConversationExportedUtterance

Object

会話型プロジェクトのエクスポートされた発話を表します。

名前	型	説明
dataset	string	この発話のデータセット。使用できる値は 'Train' と 'Test' です。
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	発話のエンティティラベルを表します。
intent	string	発話の意図。
language	string	発話の言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
text	string	発話テキスト。

ConversationalAnalysisAuthoringCreateProjectOptions

Object

プロジェクトの作成または更新に使用するオプションを表します。

名前	型	説明
description	string	プロジェクトの説明。
language	string	プロジェクト言語。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
multilingual	boolean	プロジェクトを複数の言語に使用するかどうか。
projectKind	ProjectKind	プロジェクトの種類を表します。
projectName	string	新しいプロジェクト名。
settings	ConversationalAnalysisAuthoringProjectSettings	プロジェクトの設定。

ConversationalAnalysisAuthoringExportedConversationOrchestration

Object

Conversational プロジェクトターゲットのオーケストレーションの詳細を定義します。

名前	型	説明
deploymentName	string	対象となるデプロイの名前。
projectName	string	対象プロジェクトの名前。

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Object

Conversational プロジェクトターゲットのオーケストレーションオプションを表します。

名前	型	説明
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	Conversational プロジェクトターゲットの詳細。
targetProjectKind	string: Conversation	オーケストレーションフローで使用されるターゲットの種類。

ConversationalAnalysisAuthoringExportedEntityList

Object

エンティティのリストコンポーネントを表します。

名前	型	説明
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	リストコンポーネントのサブリスト。

ConversationalAnalysisAuthoringExportedEntityListSynonym

Object

リストコンポーネント内のシノニムの一覧を表します

名前	型	説明
language	string	シノニムの言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
values	string[]	シノニムの一覧。

ConversationalAnalysisAuthoringExportedEntitySublist

Object

リストコンポーネント内のサブリストを表します。

名前	型	説明
listKey	string	サブリストのキー。
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	サブリストに対応する語句。

ConversationalAnalysisAuthoringExportedLuisOrchestration

Object

LUIS アプリケーションターゲットのオーケストレーションの詳細を定義します。

名前	型	説明
appId	string (uuid)	LUIS アプリケーション ID。
appVersion	string	対象となるバージョン ID。
slotName	string	ターゲットスロット名。

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Object

LUIS アプリケーションターゲットのオーケストレーションオプションを表します。

名前	型	説明
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	LUIS アプリケーションターゲットの詳細。
targetProjectKind	string: Luis	オーケストレーションフローで使用されるターゲットの種類。

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Object

エクスポートされた事前構築済みエンティティコンポーネントを表します

名前	型	説明
category	string	事前構築済みのエンティティカテゴリ。

ConversationalAnalysisAuthoringExportedProject

Object

エクスポートされたプロジェクトを表します。

名前	型	説明
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	プロジェクト資産を表します。
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	プロジェクトのメタデータを表します。
projectFileVersion	string	エクスポートされたファイルのバージョン。
stringIndexType	StringIndexType	文字列オフセットの解釈に使用するメソッドを指定します。詳細については、https://aka.ms/text-analytics-offsetsを参照してください。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Object

Question Answering プロジェクトターゲットのオーケストレーションの詳細を定義します。

名前	型	説明
projectName	string	ターゲットプロジェクトの名前。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Object

Question Answering プロジェクトターゲットのオーケストレーションオプションを表します。

名前	型	説明
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	質問の回答プロジェクトの詳細。
targetProjectKind	string: QuestionAnswering	オーケストレーションフローで使用されるターゲットの種類。

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Object

発話のエンティティラベルを表します。

名前	型	説明
category	string	エンティティラベルのカテゴリ。
length	integer (int32)	エンティティテキストの長さ。
offset	integer (int32)	エンティティテキストの開始位置。

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Object

オーケストレーションプロジェクトのエクスポートされた意図を表します。

名前	型	説明
category	string	意図カテゴリ。
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	オーケストレーションフローでのこの意図の動作を指定します。

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Object

オーケストレーションプロジェクトの資産を表します。

名前	型	説明
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	プロジェクトの意図を表します。
projectKind	string: Orchestration	アセットを含むプロジェクトの種類。
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	プロジェクトの発話を表します。

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Object

オーケストレーションプロジェクトの発話を表します。

名前	型	説明
dataset	string	この発話のデータセット。使用できる値は 'Train' と 'Test' です。
intent	string	発話の意図。
language	string	発話の言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
text	string	発話テキスト。

ConversationalAnalysisAuthoringProjectSettings

Object

プロジェクトの動作を定義するために使用する設定を表します。

名前	型	説明
confidenceThreshold	number (float)	予測が自動的に "なし" に変更される、最も高い信頼度を持つ意図のしきい値。

Error

Object

エラーオブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

列挙

人間が判読できるエラーコード。

値	説明
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

エラー応答。

名前	型	説明
error	Error	エラーオブジェクト。

ExportedProjectFormat

列挙

使用するエクスポートされたプロジェクトファイルの形式。

値	説明
Conversation	会話型プロジェクトの形式を指定します。
Luis	LUIS からエクスポートされたアプリケーションの形式を指定します。

InnerErrorCode

列挙

人間が判読できるエラーコード。

値	説明
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前	型	説明
code	InnerErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ProjectKind

列挙

プロジェクトの種類を表します。

値	説明
Conversation	アプリ、ボット、IoT デバイスに自然言語を組み込むプロジェクト。
Orchestration	会話、カスタムの質問への回答、LUIS プロジェクトを 1 つのプロジェクトにまとめ、調整するプロジェクト。

StringIndexType

列挙

文字列オフセットの解釈に使用するメソッドを指定します。詳細については、https://aka.ms/text-analytics-offsetsを参照してください。

値	説明
Utf16CodeUnit	オフセットと長さの値は UTF-16 コード単位に対応します。アプリケーションが Unicode (Java、JavaScript など) をサポートする言語で記述されている場合は、このオプションを使用します。

次の方法で共有

Conversational Analysis Authoring - Import

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

例

Successful Import Project

要求のサンプル

応答のサンプル

定義

CompositionSetting

ConversationalAnalysisAuthoringConversationExportedEntity

ConversationalAnalysisAuthoringConversationExportedIntent

ConversationalAnalysisAuthoringConversationExportedProjectAssets

ConversationalAnalysisAuthoringConversationExportedUtterance

ConversationalAnalysisAuthoringCreateProjectOptions

ConversationalAnalysisAuthoringExportedConversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

ConversationalAnalysisAuthoringExportedEntityList

ConversationalAnalysisAuthoringExportedEntityListSynonym

ConversationalAnalysisAuthoringExportedEntitySublist

ConversationalAnalysisAuthoringExportedLuisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

ConversationalAnalysisAuthoringExportedPrebuiltEntity

ConversationalAnalysisAuthoringExportedProject

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

ConversationalAnalysisAuthoringOrchestrationExportedIntent

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

ConversationalAnalysisAuthoringProjectSettings

Error

ErrorCode

ErrorResponse

ExportedProjectFormat

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

その他のリソース