Question Answering Projects - Export

Exportar metadados e ativos do projeto.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
Endpoint
path True

string

Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).

projectName
path True

string

O nome do projeto a ser usado.

api-version
query True

string

Versão de API do cliente.

assetKind
query

string

Tipo de ativo do projeto.

format
query

format

Formato de Importação ou Exportação da base de dados de conhecimento.

Respostas

Nome Tipo Description
200 OK

ExportJobState

Exportar status de trabalho, metadados de projeto e ativos.

202 Accepted

Uma chamada bem-sucedida resulta em 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

AADToken

Esses são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

  • Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

  • Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

Exemplos

Successful query

Solicitação de exemplo

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-01

Resposta de exemplo

{
  "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=2023-04-01"
}
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-01

Definições

Nome Description
Error

O objeto de erro.

ErrorCode

Código de erro legível por humanos.

ErrorResponse

Resposta de erro.

ExportJobState

Exportar status de trabalho, metadados de projeto e ativos.

format

Formato de Importação ou Exportação da base de dados de conhecimento.

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

O objeto de erro.

Nome Tipo Description
code

ErrorCode

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

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 pelo homem do erro.

target

string

O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome Tipo Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

Resposta de erro.

Nome Tipo Description
error

Error

O objeto de erro.

ExportJobState

Exportar status de trabalho, metadados de projeto e ativos.

Nome Tipo Description
createdDateTime

string

errors

Error[]

O objeto de erro.

expirationDateTime

string

jobId

string

lastUpdatedDateTime

string

resultUrl

string

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

status

jobStatus

Status do trabalho.

format

Formato de Importação ou Exportação da base de dados de conhecimento.

Nome Tipo Description
excel

string

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

json

string

Exportar ou importar ativos QnA no formato JSON.

tsv

string

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

InnerErrorCode

Código de erro legível por humanos.

Nome Tipo Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

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.

Nome Tipo Description
code

InnerErrorCode

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

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

Destino do erro.

jobStatus

Status do trabalho.

Nome Tipo Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string