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

Question Answering Projects - Export

导出项目元数据和资产。

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 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点 (,例如 https://.api.cognitiveservices.azure.com).

projectName
path True
  • string

要使用的项目的名称。

api-version
query True
  • string

客户端 API 版本。

assetKind
query
  • string

项目的资产类型。

format
query

知识库导入或导出格式。

请求头

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

响应

Name Type Description
200 OK

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

202 Accepted

带有用于检查作业状态的 Operation-Location 标头的成功调用结果。

Headers

  • Operation-Location: string
Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Successful query

Sample Request

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

Sample Response

Operation-Location: job1

定义

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

错误对象。

Name Type Description
code

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

details

有关导致此错误的特定错误的详细信息数组。

innererror

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

message
  • string

错误的可读表示形式。

target
  • string

错误的目标。

ErrorCode

可读错误代码。

Name Type Description
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

错误响应。

Name Type Description
error

错误对象。

ExportJobState

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

Name Type Description
createdDateTime
  • string
errors

错误对象。

expirationDateTime
  • string
jobId
  • string
lastUpdatedDateTime
  • string
resultUrl
  • string

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

status

作业状态。

format

知识库导入或导出格式。

Name Type Description
excel
  • string

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

json
  • string

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

tsv
  • string

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

InnerErrorCode

可读错误代码。

Name Type Description
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.

Name Type Description
code

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

details
  • object

错误详细信息。

innererror

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

message
  • string

错误消息。

target
  • string

错误目标。

jobStatus

作业状态。

Name Type Description
cancelled
  • string
cancelling
  • string
failed
  • string
notStarted
  • string
partiallyCompleted
  • string
running
  • string
succeeded
  • string