Text Analysis Authoring - Get Project

Servizio:

Azure AI Services

Versione API:

2022-05-01

Ottiene i dettagli di un progetto.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?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 maxLength: 100	Nome del progetto da utilizzare.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Chiave di sottoscrizione per una risorsa del servizio di linguaggio.

Risposte

Nome	Tipo	Descrizione
200 OK	TextAnalysisAuthoringProjectMetadata	Metadati del progetto.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Chiave di sottoscrizione per una risorsa del servizio di linguaggio.

Tipo: apiKey
In: header

Esempio

Successful Get Project

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

{
  "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.
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.
ProjectKind	Tipo di progetto.
TextAnalysisAuthoringProjectMetadata	Rappresenta i metadati di un progetto.

Error

Object

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

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

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.

ProjectKind

Enumerazione

Tipo di progetto.

Valore	Descrizione
CustomEntityRecognition	Per creare un modello di estrazione per identificare le categorie di dominio usando i propri dati.
CustomMultiLabelClassification	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 il file 2 viene classificato come B e C.
CustomSingleLabelClassification	Per creare un modello di classificazione per classificare il testo usando i propri dati. Ogni file avrà una sola etichetta. Ad esempio, il file 1 viene classificato come A e il file 2 viene classificato come B.

TextAnalysisAuthoringProjectMetadata

Object

Rappresenta i metadati di un progetto.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Rappresenta la data/ora di creazione del progetto.
description	string	Descrizione del progetto.
language	string	Linguaggio del progetto. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese, "en-gb" per l'inglese (Regno Unito), "es" per lo spagnolo e così via.
lastDeployedDateTime	string (date-time)	Rappresenta l'ultima data/ora dell'ultima distribuzione del progetto.
lastModifiedDateTime	string (date-time)	Rappresenta l'ultima modifica del progetto datetime.
lastTrainedDateTime	string (date-time)	Rappresenta l'ultima data/ora dell'ultimo training del progetto.
multilingual	boolean	Indica se il progetto verrà usato o meno per più lingue.
projectKind	ProjectKind	Tipo di progetto.
projectName	string	Nome del nuovo progetto.
settings	object	Impostazioni del progetto.
storageInputContainerName	string	Nome del contenitore di archiviazione.