Conversational Analysis Authoring - Export

Servizio:

Cognitive Services - Language

Versione API:

2022-05-01

Attiva un processo per esportare i dati di un progetto.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da utilizzare.
api-version	query	True	string	Versione API client.
stringIndexType	query	True	StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.
assetKind	query		string	Tipo di asset da esportare.
format	query		ExportedProjectFormat	Formato del file di progetto esportato da utilizzare.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo. Intestazioni operation-location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Tipo: apiKey
In: header

Esempio

Successful Export Project

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

202

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

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
ExportedProjectFormat	Formato del file di progetto esportato da utilizzare.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno dei set definiti dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

ExportedProjectFormat

Formato del file di progetto esportato da utilizzare.

Nome	Tipo	Descrizione
Conversation	string	Specifica il formato per un progetto di conversazione.
Luis	string	Specifica il formato per un'applicazione esportata da LUIS.

InnerErrorCode

Codice di errore leggibile.

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

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno dei set definiti dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione degli errori.

StringIndexType

Specifica il metodo utilizzato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

Nome	Tipo	Descrizione
Utf16CodeUnit	string	I valori di offset e lunghezza corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.