Text Analysis Authoring - Export
Attiva un processo per esportare i dati di un progetto.
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}&api-version=2023-04-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Nome del progetto da usare. |
api-version
|
query | True |
string |
Versione API client. |
string
|
query | True |
Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets. |
|
asset
|
query |
string |
Tipo di asset da esportare. |
|
trained
|
query |
string |
Etichetta modello sottoposta a training per l'esportazione. Se il trainingedModelLabel è Null, il comportamento predefinito consiste nell'esportare la copia di lavoro corrente. |
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. Headers operation-location: string |
|
Other Status Codes |
Risposta di errore. |
Sicurezza
AADToken
Si tratta dei flussi OAuth2 di Azure Active Directory . Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.
Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.
Note
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-id
per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.
L'oggetto Authorization URL
è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di Azure Active Directory.
* Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST.
* L'utilizzo dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Attualmente, Azure Active Directory v1.0 o v2.0 supporta Work, School e Guest, ma non supporta gli account Personali.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Descrizione |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Chiave di sottoscrizione per una risorsa del servizio lingua.
Type:
apiKey
In:
header
Esempio
Successful Export Project
Sample Request
POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
Sample Response
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. |
Error |
Codice di errore leggibile dall'utente. |
Error |
Risposta di errore. |
Inner |
Codice di errore leggibile dall'utente. |
Inner |
Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
String |
Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets. |
Error
Oggetto error.
Nome | Tipo | Descrizione |
---|---|---|
code |
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 |
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 dall'utente.
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 |
Oggetto error. |
InnerErrorCode
Codice di errore leggibile dall'utente.
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 per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nome | Tipo | Descrizione |
---|---|---|
code |
Uno di un set definito dal server di codici di errore. |
|
details |
object |
Dettagli degli errori. |
innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
message |
string |
Messaggio di errore. |
target |
string |
Destinazione errore. |
StringIndexType
Specifica il metodo usato 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. |