Question Answering Projects - Export

Service:

Azure AI Services

API Version:

2021-10-01

Export project metadata and assets.

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

With optional parameters:

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:export?api-version=2021-10-01&format={format}&assetKind={assetKind}

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName	path	True	string	The name of the project to use.
api-version	query	True	string	Client API version.
assetKind	query		string	Kind of the asset of the project.
format	query		format	Knowledge base Import or Export format.

Request Header

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

Responses

Name	Type	Description
200 OK	ExportJobState	Export job status, project metadata, and assets.
202 Accepted		A successful call results with an Operation-Location header used to check the status of the job. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

HTTP

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

Sample response

Status code:

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"
}

Status code:

202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

Definitions

Name	Description
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
ExportJobState	Export job status, project metadata, and assets.
format	Knowledge base Import or Export format.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	Job Status.

Error

Object

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

ExportJobState

Object

Export job status, project metadata, and assets.

Name	Type	Description
createdDateTime	string
errors	Error[]	The error object.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL to download the result of the Export Job.
status	jobStatus	Job Status.

format

Enumeration

Knowledge base Import or Export format.

Value	Description
excel	Export or Import knowledge base replica including all assets and metadata in Tsv format.
json	Export or Import QnA assets in JSON format.
tsv	Export or Import knowledge base replica including all assets and metadata in Excel format.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

jobStatus

Enumeration

Job Status.

Value	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded