次の方法で共有

Conversational Analysis Authoring - Export

  • リファレンス
サービス:
Cognitive Services - Language
API バージョン:
2022-05-01

プロジェクトのデータをエクスポートするジョブをトリガーします。

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2022-05-01
省略可能なパラメーターを含む: 
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?format={format}&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&api-version=2022-05-01

URI パラメーター

名前 / 必須 型 説明
Endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
projectName
 path True

string

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

string

クライアント API バージョン。
stringIndexType
 query True

StringIndexType

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

string

エクスポートする資産の種類。
format
 query

ExportedProjectFormat

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

要求ヘッダー

名前 必須 型 説明
Ocp-Apim-Subscription-Key True

string

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

応答

名前 型 説明
202 Accepted

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

ヘッダー

operation-location: string
Other Status Codes

ErrorResponse

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

例

Successful Export Project

要求のサンプル

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

応答のサンプル

状態コード:
202 
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

定義

名前 説明
Error

error オブジェクト。
ErrorCode

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

エラー応答。
ExportedProjectFormat

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

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

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

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

Error

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

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

エラー ターゲット。

StringIndexType

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

名前 型 説明
Utf16CodeUnit

string

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