Question Answering Projects - Export

Service:

Cognitive Services

API Version:

2021-10-01

Ekspor metadata dan aset proyek.

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}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nama proyek yang akan digunakan.
api-version	query	True	string	Versi API klien.
assetKind	query		string	Jenis aset proyek.
format	query		format	Format Impor atau Ekspor pangkalan pengetahuan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	ExportJobState	Ekspor status pekerjaan, metadata proyek, dan aset.
202 Accepted		Hasil call yang sukses dengan header Operasi-Lokasi yang digunakan untuk memeriksa status pekerjaan. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Contoh

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

Definisi

Nama	Deskripsi
Error	Objek kesalahan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
ExportJobState	Ekspor status pekerjaan, metadata proyek, dan aset.
format	Format Impor atau Ekspor pangkalan pengetahuan.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	Status Pekerjaan.

Error

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Salah satu set kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
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

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

ExportJobState

Ekspor status pekerjaan, metadata proyek, dan aset.

Nama	Jenis	Deskripsi
createdDateTime	string
errors	Error[]	Objek kesalahan.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL untuk mengunduh hasil Pekerjaan Ekspor.
status	jobStatus	Status Pekerjaan.

format

Format Impor atau Ekspor pangkalan pengetahuan.

Nama	Jenis	Deskripsi
excel	string	Ekspor atau Impor replika Pangkalan Pengetahuan termasuk semua aset dan metadata dalam format Tsv.
json	string	Ekspor atau Impor aset QnA dalam format JSON.
tsv	string	Ekspor atau Impor replika Pangkalan Pengetahuan termasuk semua aset dan metadata dalam format Excel.

InnerErrorCode

Kode kesalahan yang dapat dibaca manusia.

Nama	Jenis	Deskripsi
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nama	Jenis	Deskripsi
code	InnerErrorCode	Salah satu set kode kesalahan yang ditentukan server.
details	object	Detail kesalahan.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

jobStatus

Status Pekerjaan.

Nama	Jenis	Deskripsi
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string