Question Answering Projects - Export

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-15-preview

Exporte metadados e ativos do projeto.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
projectName	path	True	string	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.
assetKind	query		assetKind	Tipo de ativo do projeto.
format	query		format	Base de dados de conhecimento Formato de importação ou exportação.

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.

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

AADToken

Estes são os Fluxos de do Azure Ative Directory OAuth2. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 APIs REST do Azure Maps.

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

Observações

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

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 Ative Directory. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Ative Directory v1.0 ou v2.0 oferece suporte a Trabalho, Escola e Convidados, mas não oferece suporte a contas Pessoais.

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

Âmbitos

Name	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 idioma.

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

HTTP

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

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=2023-04-15-preview"
}

Código de estado:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-15-preview

Definições

Name	Description
assetKind	Tipo de ativo do projeto.
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.

assetKind

Tipo de ativo do projeto.

Name	Tipo	Description
qnas	string
synonyms	string

Error

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

Código de erro legível por humanos.

Name	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.

Name	Tipo	Description
error	Error	O objeto de erro.

ExportJobState

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

Name	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

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

Name	Tipo	Description
excel	string	Exporte ou importe a réplica da base de dados de conhecimento, incluindo todos os ativos e metadados no formato Tsv.
json	string	Exporte ou importe ativos QnA no formato JSON.
tsv	string	Exporte ou importe a réplica da base de dados de conhecimento, incluindo todos os ativos e metadados no formato Excel.

InnerErrorCode

Código de erro legível por humanos.

Name	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.

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

Status do trabalho.

Name	Tipo	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

Partilhar via

Question Answering Projects - Export

Parâmetros do URI

Respostas

Segurança

AADToken

Observações

Âmbitos

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Pedido de amostra

Resposta da amostra

Definições

assetKind

Error

ErrorCode

ErrorResponse

ExportJobState

format

InnerErrorCode

InnerErrorModel

jobStatus

Recursos adicionais