Partilhar via

Question Answering Projects - Export

Serviço:
Azure AI Services
Versão da API:
2021-10-01

Exporte metadados e ativos do projeto.

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

Parâmetros do URI

Name Em Necessário Tipo Description
Endpoint
 path True

string

Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName
 path True

string

maxLength: 100

O nome do projeto a ser usado.
api-version
 query True

string

Versão da API do cliente.
assetKind
 query

string

Tipo de ativo do projeto.
format
 query

format

Base de dados de conhecimento Formato de importação ou exportação.

Cabeçalho do Pedido

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

Respostas

Name Tipo Description
200 OK

ExportJobState

Exporte o status do trabalho, os metadados do projeto e os ativos.
202 Accepted

Uma chamada bem-sucedida resulta com um cabeçalho Operation-Location usado para verificar o status do trabalho.

Cabeçalhos

Operation-Location: string
Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

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

Resposta da amostra

Código de estado:
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"
}
Código de estado:
202 
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2021-10-01

Definições

Name Description
Error

O objeto de erro.
ErrorCode

Código de erro legível por humanos.
ErrorResponse

Resposta de erro.
ExportJobState

Exporte o status do trabalho, os metadados do projeto e os ativos.
format

Base de dados de conhecimento Formato de importação ou exportação.
InnerErrorCode

Código de erro legível por humanos.
InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus

Status do trabalho.

Error

Object

O objeto de erro.

Name Tipo Description
code

ErrorCode

Um de um conjunto de códigos de erro definido pelo servidor.
details

Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

InnerErrorModel

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível por humanos do erro.
target

string

O alvo do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

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

ErrorResponse

Object

Resposta de erro.

Name Tipo Description
error

Error

O objeto de erro.

ExportJobState

Object

Exporte o status do trabalho, os metadados do projeto e os ativos.

Name Tipo Description
createdDateTime

string (date-time)

errors

Error[]

O objeto de erro.
expirationDateTime

string (date-time)

jobId

string

lastUpdatedDateTime

string (date-time)

resultUrl

string

URL para baixar o resultado do Trabalho de Exportação.
status

jobStatus

Status do trabalho.

format

Enumeração

Base de dados de conhecimento Formato de importação ou exportação.

Valor Description
json

Exporte ou importe ativos QnA no formato JSON.
tsv

Exporte ou importe a réplica da base de dados de conhecimento, incluindo todos os ativos e metadados no formato Excel.
excel

Exporte ou importe a réplica da base de dados de conhecimento, incluindo todos os ativos e metadados no formato Tsv.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Tipo Description
code

InnerErrorCode

Um de um conjunto de códigos de erro definido pelo servidor.
details

object

Detalhes do erro.
innererror

InnerErrorModel

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Mensagem de erro.
target

string

Alvo de erro.

jobStatus

Enumeração

Status do trabalho.

Valor Description
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted