Question Answering Projects - Export

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-15-preview

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

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview

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

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview&format={format}&assetKind={assetKind}

URI パラメーター

名前	/	必須	型	説明
projectName	path	True	string	使用するプロジェクトの名前。
api-version	query	True	string	クライアント API のバージョン。
assetKind	query		assetKind	プロジェクトの資産の種類。
format	query		format	ナレッジベースのインポートまたはエクスポートの形式。

応答

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

名前

型

説明

200 OK

ExportJobState

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

202 Accepted

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

ヘッダー

Operation-Location: string

Other Status Codes

ErrorResponse

エラー応答。

セキュリティ

AADToken

これらは、Azure Active Directory OAuth2 フローです。 Azure ロールベースアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

筆記

このセキュリティ定義 では、x-ms-client-id ヘッダー 使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。これは、Maps 管理 APIから取得できます。

Authorization URL は、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、一意の承認 URL と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して、Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対するアプリケーションの構成ベースのセットアップが可能になります。

現時点では、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

例

Successful query

要求のサンプル

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-15-preview

応答のサンプル

状態コード:: 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=2023-04-15-preview"
}

状態コード:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-15-preview

定義

名前	説明
assetKind	プロジェクトの資産の種類。
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	ジョブの状態。

assetKind

プロジェクトの資産の種類。

名前	型	説明
qnas	string
synonyms	string

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	エラーオブジェクト。

ExportJobState

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

名前	型	説明
createdDateTime	string
errors	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
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	エラーターゲット。

jobStatus

ジョブの状態。

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

次の方法で共有

Question Answering Projects - Export

URI パラメーター

応答

セキュリティ

AADToken

筆記

スコープ

Ocp-Apim-Subscription-Key

例

Successful query

要求のサンプル

応答のサンプル

定義

assetKind

Error

ErrorCode

ErrorResponse

ExportJobState

format

InnerErrorCode

InnerErrorModel

jobStatus

その他のリソース