通过

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

Question Answering Projects - Export

服务:
Azure AI Services
API 版本:
2021-10-01

导出项目元数据和资产。

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01
具有可选参数: 
POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01&format={format}&assetKind={assetKind}

URI 参数

名称 在 必需 类型 说明
Endpoint
 path True

string

支持的认知服务终结点（例如，https://< resource-name.api.cognitiveservices.azure.com>）。
projectName
 path True

string

maxLength: 100

要使用的项目的名称。
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 标头的成功调用结果。

标头

Operation-Location: string
Other Status Codes

ErrorResponse

错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

Successful query

示例请求

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

示例响应

状态代码:
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"
}
状态代码:
202 
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

定义

名称 说明
Error

错误对象。
ErrorCode

人工可读错误代码。
ErrorResponse

错误响应。
ExportJobState

导出作业状态、项目元数据和资产。
format

知识库导入或导出格式。
InnerErrorCode

人工可读错误代码。
InnerErrorModel

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
jobStatus

作业状态。

Error

Object

错误对象。

名称 类型 说明
code

ErrorCode

服务器定义的错误代码集之一。
details

Error[]

导致此报告错误的特定错误的详细信息数组。
innererror

InnerErrorModel

包含与当前对象有关错误的更具体信息的对象。
message

string

错误的人工可读表示形式。
target

string

错误的目标。

ErrorCode

枚举

人工可读错误代码。

值 说明
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

错误响应。

名称 类型 说明
error

Error

错误对象。

ExportJobState

Object

导出作业状态、项目元数据和资产。

名称 类型 说明
createdDateTime

string (date-time)

errors

Error[]

错误对象。
expirationDateTime

string (date-time)

jobId

string

lastUpdatedDateTime

string (date-time)

resultUrl

string

用于下载导出作业结果的 URL。
status

jobStatus

作业状态。

format

枚举

知识库导入或导出格式。

值 说明
json

以 JSON 格式导出或导入 QnA 资产。
tsv

导出或导入知识库副本，包括 Excel 格式的所有资产和元数据。
excel

导出或导入知识库副本，包括 Tsv 格式的所有资产和元数据。

InnerErrorCode

枚举

人工可读错误代码。

值 说明
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

包含有关错误的更具体信息的对象。 根据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

枚举

作业状态。

值 说明
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted