你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 基于角色的访问控制用于指定对一个或多个 Azure Maps 资源帐户或子资源的访问。任何用户、组或服务主体都可以通过内置角色或由一个或多个对 Azure Maps REST API 的权限组成的自定义角色授予访问权限。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一种解决方案，用于通过能够针对特定 API 和范围进行访问控制的对象对应用程序建模。

笔记

此安全定义要求使用 x-ms-client-id 标头来指示应用程序请求访问的 Azure Maps 资源。这可以从地图管理 API获取。

Authorization URL 特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 azure Maps Web SDK 允许为多个用例设置基于应用程序的配置。

目前，Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾，但不支持个人帐户。

类型: oauth2
流向: implicit
授权 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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
jobStatus	作业状态。

assetKind

项目的资产类型。

名称	类型	说明
qnas	string
synonyms	string

Error

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
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

其他资源