Question Answering Projects - Export

Service:

Cognitive Services

API Version:

2021-10-01

プロジェクトのメタデータと資産をエクスポートします。

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01

With optional parameters:

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01&format={format}&assetKind={assetKind}

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
projectName	path	True	string	使用するプロジェクトの名前。
api-version	query	True	string	クライアント API バージョン。
assetKind	query		string	プロジェクトの資産の種類。
format	query		format	ナレッジ ベースのインポートまたはエクスポート形式。

要求ヘッダー

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

応答

名前	型	説明
200 OK	ExportJobState	ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。
202 Accepted		呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。 Headers Operation-Location: string
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

例

Successful query

Sample Request

HTTP

POST {Endpoint}/language/query-knowledgebases/projects/proj1/:export?api-version=2021-10-01

Sample Response

Status code:

200

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded",
  "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2021-10-01"
}

Status code:

202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

定義

名前	説明
Error	error オブジェクト。
ErrorCode	人間が判読できるエラー コード。
ErrorResponse	エラー応答。
ExportJobState	ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。
format	ナレッジ ベースのインポートまたはエクスポート形式。
InnerErrorCode	人間が判読できるエラー コード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
jobStatus	ジョブの状態。

Error

error オブジェクト。

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

ErrorCode

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

名前	型	説明
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

エラー応答。

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

ExportJobState

ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。

名前	型	説明
createdDateTime	string
errors	Error[]	error オブジェクト。
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	エクスポート ジョブの結果をダウンロードする URL。
status	jobStatus	ジョブの状態。

format

ナレッジ ベースのインポートまたはエクスポート形式。

名前	型	説明
excel	string	すべての資産とメタデータを含むサポート情報レプリカを Tsv 形式でエクスポートまたはインポートします。
json	string	JSON 形式で QnA アセットをエクスポートまたはインポートします。
tsv	string	Excel 形式のすべての資産とメタデータを含むサポート情報レプリカをエクスポートまたはインポートします。

InnerErrorCode

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

名前	型	説明
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	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	エラーターゲット。

jobStatus

ジョブの状態。

名前	型	説明
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string