Text Analysis Authoring - Export

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2023-04-01

Attiva un processo per esportare i dati di un progetto.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit
Con parametri facoltativi: 
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
Endpoint
 path True

string

url

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 dell'API da usare per questa operazione.
stringIndexType
 query True

StringIndexType

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

string

Tipo di asset da esportare.
trainedModelLabel
 query

string

Etichetta del modello con training da esportare. Se trainedModelLabel è null, il comportamento predefinito consiste nell'esportare la copia di lavoro corrente.

Risposte

Nome Tipo Descrizione
202 Accepted

La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata.

Intestazioni

Operation-Location: string
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

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

Esempio

Successful Export Project

Esempio di richiesta

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

Risposta di esempio

Codice di stato:
202 
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

Definizioni

Nome Descrizione
Error

Oggetto error.
ErrorCode

Codice di errore leggibile.
ErrorResponse

Risposta di errore.
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

Error

Oggetto error.

Nome Tipo Descrizione
code

ErrorCode

Uno di un set definito dal server di codici di errore.
details

Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'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.

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 di un set definito 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 errore.

StringIndexType

Nome Tipo Descrizione
Utf16CodeUnit

string

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