Question Answering Projects - Export

Referência

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Exportar metadados e recursos do projeto.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.
assetKind	query		string	Tipo de recurso do projeto.
format	query		format	Formato de Importação ou Exportação da base de dados de conhecimento.

Respostas

Name	Tipo	Description
200 OK	ExportJobState	Exportar o estado da tarefa, os metadados do projeto e os recursos.
202 Accepted		Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Resposta de erro.

Name

Tipo

Description

200 OK

ExportJobState

Exportar o estado da tarefa, os metadados do projeto e os recursos.

202 Accepted

Um resultado de chamada bem-sucedido com um cabeçalho de Operation-Location utilizado para verificar o estado da tarefa.

Headers

Operation-Location: string

Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Type: apiKey
In: header

Exemplos

Successful query

Sample Request

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-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=2023-04-01"
}

Status code:: 202

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

Definições

Name	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
ExportJobState	Exportar o estado da tarefa, os metadados do projeto e os recursos.
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
jobStatus	Estado da Tarefa.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
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 destino 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

Exportar o estado da tarefa, os metadados do projeto e os recursos.

Name	Tipo	Description
createdDateTime	string
errors	Error[]	O objeto de erro.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL para transferir o resultado da Tarefa de Exportação.
status	jobStatus	Estado da Tarefa.

format

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

Name	Tipo	Description
excel	string	Export or Import base de dados de conhecimento replica including all assets and metadata in Tsv format (Exportar ou Importar base de dados de conhecimento réplica, incluindo todos os recursos e metadados no formato Tsv).
json	string	Exportar ou Importar recursos de FAQ no formato JSON.
tsv	string	Export or Import base de dados de conhecimento replica including all assets and metadata in Excel format (Exportar ou Importar base de dados de conhecimento réplica, incluindo todos os recursos e metadados no formato do 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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos 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	Destino do erro.

jobStatus

Estado da Tarefa.

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

Notas

Scopes

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Sample Request

Sample Response

Definições

Error

ErrorCode

ErrorResponse

ExportJobState

format

InnerErrorCode

InnerErrorModel

jobStatus

Recursos adicionais