Conversational Analysis Authoring - Import

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2023-04-01

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

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2023-04-01
省略可能なパラメーターを含む: 
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2023-04-01&format={format}

URI パラメーター

名前 / 必須 型 説明
Endpoint
 path True

string

projectName
 path True

string

使用するプロジェクトの名前。
api-version
 query True

string

この操作に使用する API バージョン。
format
 query

ExportedProjectFormat

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

要求本文

名前 必須 型 説明
metadata True

ConversationalAnalysisAuthoringCreateProjectOptions

プロジェクトのメタデータを表します。
projectFileVersion True

string

エクスポートされたファイルのバージョン。
stringIndexType True

StringIndexType

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

プロジェクト資産を表します。

応答

名前 型 説明
202 Accepted

要求は処理のために受け入れ済みですが、処理はまだ完了していません。

ヘッダー

Operation-Location: string
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前 説明
https://cognitiveservices.azure.com/.default

例

Successful Import Project

要求のサンプル

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2023-04-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"
      },
      {
        "category": "Number",
        "regex": {
          "expressions": [
            {
              "regexKey": "UK Phone numbers",
              "language": "en-us",
              "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/"
            }
          ]
        }
      }
    ],
    "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=2023-04-01

定義

名前 説明
CompositionSetting
ConversationalAnalysisAuthoringConversationExportedEntity

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

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

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

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

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

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

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

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

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

エンティティの正規表現コンポーネントを表します。
ConversationalAnalysisAuthoringExportedEntityRegexExpression

正規表現コンポーネント内の正規表現式を表します。 この式は、.NET 正規表現構文に従います。 リファレンスについては、こちらを参照してください: https://video2.skills-academy.com/dotnet/standard/base-types/regular-expressions
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.
OrchestrationTargetProjectKind
ProjectKind
StringIndexType

CompositionSetting

名前 型 説明
combineComponents

string

テキスト内に複数のコンポーネントが見つかり、重なっている場合、コンポーネントのスパンは 1 つのスパンにまとめられ、それらのすべてが結合されます。
requireExactOverlap

string

すべてのコンポーネントは、返されるエンティティのテキスト内のまったく同じ文字で重なっている必要があります。 定義されたコンポーネントのいずれかが一致または予測されていない場合、エンティティは返されません。
returnLongestOverlap

string

テキスト内に複数のコンポーネントが見つかり、重複している場合は、最も長い文字セットを持つコンポーネントが返されます。
separateComponents

string

すべてのコンポーネントの一致または予測は、エンティティの個別のインスタンスとして返されます。

ConversationalAnalysisAuthoringConversationExportedEntity

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

名前 型 説明
category

string

エンティティのカテゴリ。
compositionSetting

CompositionSetting

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

ConversationalAnalysisAuthoringExportedEntityList

エンティティのリスト コンポーネント。
prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

事前構築済みのエンティティ コンポーネント。
regex

ConversationalAnalysisAuthoringExportedEntityRegex

エンティティの正規表現コンポーネント。
requiredComponents

string[]

必要なコンポーネント。 使用できる値は、'learned'、'list'、'prebuilts'、および 'regex' です。

ConversationalAnalysisAuthoringConversationExportedIntent

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

名前 型 説明
category

string

意図カテゴリ。

ConversationalAnalysisAuthoringConversationExportedProjectAssets

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

名前 型 説明
entities

ConversationalAnalysisAuthoringConversationExportedEntity[]

プロジェクトで定義されているエンティティ。
intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

プロジェクトで定義されている意図。
projectKind string:

Conversation

アセットを含むプロジェクトの種類。
utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

プロジェクトで定義されている発話。

ConversationalAnalysisAuthoringConversationExportedUtterance

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

名前 型 説明
dataset

string

この発話のデータセット。 使用できる値は 'Train' と 'Test' です。
entities

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]

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

string

発話の意図。
language

string

発話の言語を表します。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
text

string

発話テキスト。

ConversationalAnalysisAuthoringCreateProjectOptions

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

名前 型 説明
description

string

プロジェクトの説明。
language

string

プロジェクト言語。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
multilingual

boolean

プロジェクトを複数の言語に使用するかどうか。
projectKind

ProjectKind

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

string

新しいプロジェクト名。
settings

ConversationalAnalysisAuthoringProjectSettings

プロジェクトの設定。

ConversationalAnalysisAuthoringExportedConversationOrchestration

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

名前 型 説明
deploymentName

string

対象となるデプロイの名前。
projectName

string

対象プロジェクトの名前。

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

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

名前 型 説明
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Conversational プロジェクトターゲットの詳細。
targetProjectKind string:

Conversation

ConversationalAnalysisAuthoringExportedEntityList

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

名前 型 説明
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

リスト コンポーネントのサブリスト。

ConversationalAnalysisAuthoringExportedEntityListSynonym

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

名前 型 説明
language

string

シノニムの言語を表します。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
values

string[]

シノニムの一覧。

ConversationalAnalysisAuthoringExportedEntityRegex

エンティティの正規表現コンポーネントを表します。

名前 型 説明
expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression[]

正規表現コンポーネントの正規表現式。 これらの式は、.NET 正規表現構文に従います。 リファレンスについては、こちらを参照してください: https://video2.skills-academy.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

正規表現コンポーネント内の正規表現式を表します。 この式は、.NET 正規表現構文に従います。 リファレンスについては、こちらを参照してください: https://video2.skills-academy.com/dotnet/standard/base-types/regular-expressions

名前 型 説明
language

string

正規表現式の言語を表します。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
regexKey

string

正規表現式のキー。
regexPattern

string

正規表現パターン。

ConversationalAnalysisAuthoringExportedEntitySublist

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

名前 型 説明
listKey

string

サブリストのキー。
synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

サブリストに対応する語句。

ConversationalAnalysisAuthoringExportedLuisOrchestration

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

名前 型 説明
appId

string

LUIS アプリケーション ID。
appVersion

string

対象となるバージョン ID。
slotName

string

ターゲット スロット名。

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

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

名前 型 説明
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

LUIS アプリケーション ターゲットの詳細。
targetProjectKind string:

Luis

ConversationalAnalysisAuthoringExportedPrebuiltEntity

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

名前 型 説明
category

string

事前構築済みのエンティティ カテゴリ。

ConversationalAnalysisAuthoringExportedProject

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

名前 型 説明
assets ConversationalAnalysisAuthoringExportedProjectAssets:

プロジェクト資産を表します。
metadata

ConversationalAnalysisAuthoringCreateProjectOptions

プロジェクトのメタデータを表します。
projectFileVersion

string

エクスポートされたファイルのバージョン。
stringIndexType

StringIndexType

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

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

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

名前 型 説明
projectName

string

ターゲット プロジェクトの名前。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

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

名前 型 説明
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

質問の回答プロジェクトの詳細。
targetProjectKind string:

QuestionAnswering

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

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

名前 型 説明
category

string

エンティティ ラベルのカテゴリ。
length

integer

エンティティ テキストの長さ。
offset

integer

エンティティ テキストの開始位置。

ConversationalAnalysisAuthoringOrchestrationExportedIntent

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

名前 型 説明
category

string

意図カテゴリ。
orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

オーケストレーション フローでのこの意図の動作を指定します。

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

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

名前 型 説明
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

プロジェクトの意図を表します。
projectKind string:

Orchestration

アセットを含むプロジェクトの種類。
utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

プロジェクトの発話を表します。

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

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

名前 型 説明
dataset

string

この発話のデータセット。 使用できる値は 'Train' と 'Test' です。
intent

string

発話の意図。
language

string

発話の言語を表します。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
text

string

発話テキスト。

ConversationalAnalysisAuthoringProjectSettings

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

名前 型 説明
confidenceThreshold

number

予測が自動的に "なし" に変更される、最も高い信頼度を持つ意図のしきい値。 しきい値の値は、0 ~ 1 の範囲にする必要があります。

Error

エラー オブジェクト。

名前 型 説明
code

ErrorCode

サーバー定義の一連のエラー コードの 1 つ。
details

Error[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror

InnerErrorModel

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message

string

エラーの人間が判読できる表現。
target

string

エラーのターゲット。

ErrorCode

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

名前 型 説明
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

エラー応答。

名前 型 説明
error

Error

エラー オブジェクト。

ExportedProjectFormat

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

名前 型 説明
Conversation

string

会話型プロジェクトの形式を指定します。
Luis

string

LUIS からエクスポートされたアプリケーションの形式を指定します。

InnerErrorCode

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

名前 型 説明
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 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

エラーターゲット。

OrchestrationTargetProjectKind

名前 型 説明
Conversation

string

Luis

string

QuestionAnswering

string

ProjectKind

名前 型 説明
Conversation

string

アプリ、ボット、IoT デバイスに自然言語を組み込むプロジェクト。
Orchestration

string

会話、カスタムの質問への回答、LUIS プロジェクトを 1 つのプロジェクトにまとめ、調整するプロジェクト。

StringIndexType

名前 型 説明
Utf16CodeUnit

string

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