Condividi tramite


Text Analysis Authoring - Get Project

Ottiene i dettagli di un progetto.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?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).

projectName
path True

string

Nome del progetto da usare.

api-version
query True

string

Versione API client.

Risposte

Nome Tipo Descrizione
200 OK

TextAnalysisAuthoringProjectMetadata

Metadati del progetto.

Other Status Codes

ErrorResponse

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.

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

Ambiti

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.

Tipo: apiKey
In: header

Esempio

Successful Get Project

Esempio di richiesta

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

Risposta di esempio

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

Definizioni

Nome Descrizione
Error

Oggetto error.

ErrorCode

Codice di errore leggibile dall'utente.

ErrorResponse

Risposta di errore.

InnerErrorCode

Codice di errore leggibile dall'utente.

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.

ProjectKind

Tipo di progetto.

TextAnalysisAuthoringProjectMetadata

Rappresenta i metadati di un progetto.

TextAnalysisAuthoringProjectSettings

Rappresenta le impostazioni usate per definire il comportamento del progetto.

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

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

InnerErrorCode

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

details

object

Dettagli degli errori.

innererror

InnerErrorModel

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.

message

string

Messaggio di errore.

target

string

Destinazione errore.

ProjectKind

Tipo di progetto.

Nome Tipo Descrizione
CustomEntityRecognition

string

Per creare un modello di estrazione per identificare le categorie di dominio usando i propri dati.

CustomMultiLabelClassification

string

Per creare un modello di classificazione per classificare il testo usando i propri dati. Ogni file può avere una o più etichette. Ad esempio, il file 1 viene classificato come A, B e C e file 2 è classificato come B e C.

CustomSingleLabelClassification

string

Per creare un modello di classificazione per classificare il testo usando i propri dati. Ogni file avrà solo un'etichetta. Ad esempio, il file 1 viene classificato come A e file 2 è classificato come B.

TextAnalysisAuthoringProjectMetadata

Rappresenta i metadati di un progetto.

Nome Tipo Descrizione
createdDateTime

string

Rappresenta la datatime di creazione del progetto.

description

string

Descrizione del progetto.

language

string

Lingua del progetto. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.

lastDeployedDateTime

string

Rappresenta l'ultima data di distribuzione del progetto.

lastModifiedDateTime

string

Rappresenta l'ultima modifica del progetto datetime.

lastTrainedDateTime

string

Rappresenta l'ultima data di training del progetto.

multilingual

boolean

Indipendentemente dal fatto che il progetto venga usato per più lingue o meno.

projectKind

ProjectKind

Tipo di progetto.

projectName

string

Nuovo nome del progetto.

settings

TextAnalysisAuthoringProjectSettings

Impostazioni del progetto.

storageInputContainerName

string

Nome del contenitore di archiviazione.

TextAnalysisAuthoringProjectSettings

Rappresenta le impostazioni usate per definire il comportamento del progetto.

Nome Tipo Descrizione
confidenceThreshold

number

Soglia della classe con maggiore attendibilità, in cui la stima verrà modificata automaticamente in "Nessuno". Il valore della soglia deve essere compreso tra 0 e 1 incluso.