Question Answering Projects - Export
プロジェクトのメタデータとアセットをエクスポートします。
POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01&format={format}&assetKind={assetKind}URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (https://<resource-name>.api.cognitiveservices.azure.com など)。 |
|
project
|
path | True |
string maxLength: 100 |
使用するプロジェクトの名前。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
|
asset
|
query |
string |
プロジェクトの資産の種類。 |
|
|
format
|
query |
ナレッジ ベースのインポートまたはエクスポートの形式。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Ocp-Apim-Subscription-Key | True |
string |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。 |
|
| 202 Accepted |
呼び出しが成功すると、ジョブの状態を確認するために使用する Operation-Location ヘッダーが返されます。 ヘッダー Operation-Location: string |
|
| Other Status Codes |
エラー応答。 |
セキュリティ
Ocp-Apim-Subscription-Key
型:
apiKey
/:
header
例
Successful query
要求のサンプル
POST {Endpoint}/language/query-knowledgebases/projects/proj1/:export?api-version=2021-10-01
応答のサンプル
{
"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"
}Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01 定義
| 名前 | 説明 |
|---|---|
| Error |
エラー オブジェクト。 |
|
Error |
人間が判読できるエラー コード。 |
|
Error |
エラー応答。 |
|
Export |
ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。 |
| format |
ナレッジ ベースのインポートまたはエクスポートの形式。 |
|
Inner |
人間が判読できるエラー コード。 |
|
Inner |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
|
job |
ジョブの状態。 |
Error
エラー オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| code |
サーバー定義の一連のエラー コードの 1 つ。 |
|
| details |
Error[] |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
| message |
string |
エラーの人間が判読できる表現。 |
| target |
string |
エラーのターゲット。 |
ErrorCode
人間が判読できるエラー コード。
| 値 | 説明 |
|---|---|
| InvalidRequest | |
| InvalidArgument | |
| Unauthorized | |
| Forbidden | |
| NotFound | |
| ProjectNotFound | |
| OperationNotFound | |
| AzureCognitiveSearchNotFound | |
| AzureCognitiveSearchIndexNotFound | |
| TooManyRequests | |
| AzureCognitiveSearchThrottling | |
| AzureCognitiveSearchIndexLimitReached | |
| InternalServerError | |
| ServiceUnavailable |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
ExportJobState
ジョブの状態、プロジェクト メタデータ、および資産をエクスポートします。
| 名前 | 型 | 説明 |
|---|---|---|
| createdDateTime |
string (date-time) |
|
| errors |
Error[] |
エラー オブジェクト。 |
| expirationDateTime |
string (date-time) |
|
| jobId |
string |
|
| lastUpdatedDateTime |
string (date-time) |
|
| resultUrl |
string |
エクスポート ジョブの結果をダウンロードするための URL。 |
| status |
ジョブの状態。 |
format
ナレッジ ベースのインポートまたはエクスポートの形式。
| 値 | 説明 |
|---|---|
| json |
JSON 形式で QnA 資産をエクスポートまたはインポートします。 |
| tsv |
Excel 形式のすべての資産とメタデータを含むナレッジ ベース レプリカをエクスポートまたはインポートします。 |
| excel |
Tsv 形式のすべての資産とメタデータを含むナレッジ ベース レプリカをエクスポートまたはインポートします。 |
InnerErrorCode
人間が判読できるエラー コード。
| 値 | 説明 |
|---|---|
| InvalidRequest | |
| InvalidParameterValue | |
| KnowledgeBaseNotFound | |
| AzureCognitiveSearchNotFound | |
| AzureCognitiveSearchThrottling | |
| ExtractionFailure |
InnerErrorModel
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
| 名前 | 型 | 説明 |
|---|---|---|
| code |
サーバー定義の一連のエラー コードの 1 つ。 |
|
| details |
object |
エラーの詳細。 |
| innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
| message |
string |
エラーメッセージ。 |
| target |
string |
エラーターゲット。 |
jobStatus
ジョブの状態。
| 値 | 説明 |
|---|---|
| notStarted | |
| running | |
| succeeded | |
| failed | |
| cancelled | |
| cancelling | |
| partiallyCompleted |