Compartilhar via

Conversational Analysis Authoring - Export

  • Referência
Serviço:
Cognitive Services - Language
Versão da API:
2022-05-01

Dispara um trabalho para exportar os dados de um projeto.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2022-05-01
Com parâmetros opcionais: 
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:export?format={format}&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&api-version=2022-05-01

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.
stringIndexType
 query True

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.
assetKind
 query

string

Tipo de ativo a ser exportado.
format
 query

ExportedProjectFormat

O formato do arquivo de projeto exportado a ser usado.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

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

Respostas

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

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Exemplos

Successful Export Project

Solicitação de exemplo

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:export?stringIndexType=Utf16CodeUnit&api-version=2022-05-01

Resposta de exemplo

Código de status:
202 
operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definições

Nome Description
Error

O objeto de erro.
ErrorCode

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

Resposta de erro.
ExportedProjectFormat

O formato do arquivo de projeto exportado a ser usado.
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.
StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

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

ExportedProjectFormat

O formato do arquivo de projeto exportado a ser usado.

Nome Tipo Description
Conversation

string

Especifica o formato de um projeto de conversa.
Luis

string

Especifica o formato de um aplicativo que foi exportado do LUIS.

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 de erro.

StringIndexType

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter mais informações, consulte https://aka.ms/text-analytics-offsets.

Nome Tipo Description
Utf16CodeUnit

string

Os valores de deslocamento e comprimento corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em uma linguagem que dê suporte a Unicode, por exemplo, Java, JavaScript.