Question Answering Projects - Export

Service:

Cognitive Services

API Version:

2021-10-01

Esportare i metadati e gli asset del progetto.

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da utilizzare.
api-version	query	True	string	Versione API client.
assetKind	query		string	Tipo di asset del progetto.
format	query		format	Formato di importazione o esportazione della Knowledge Base.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Risposte

Nome	Tipo	Descrizione
200 OK	ExportJobState	Esportare lo stato del processo, i metadati del progetto e gli asset.
202 Accepted		Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Esempio

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

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
ExportJobState	Esportare lo stato del processo, i metadati del progetto e gli asset.
format	Formato di importazione o esportazione della Knowledge Base.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	Stato processo.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

ExportJobState

Esportare lo stato del processo, i metadati del progetto e gli asset.

Nome	Tipo	Descrizione
createdDateTime	string
errors	Error[]	Oggetto error.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL per scaricare il risultato del processo di esportazione.
status	jobStatus	Stato processo.

format

Formato di importazione o esportazione della Knowledge Base.

Nome	Tipo	Descrizione
excel	string	Esportare o importare knowledge base replica, inclusi tutti gli asset e i metadati in formato Tsv.
json	string	Esportare o importare asset QnA in formato JSON.
tsv	string	Esportare o importare knowledge base replica, inclusi tutti gli asset e i metadati in formato Excel.

InnerErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno dei set definiti dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione degli errori.

jobStatus

Stato processo.

Nome	Tipo	Descrizione
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string