Text Analysis Authoring - List Projects

Riferimento

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Elenchi i progetti esistenti.

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

With optional parameters:

GET {Endpoint}/language/authoring/analyze-text/projects?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-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).
api-version	query	True	string	Versione API client.
maxpagesize	query		integer int32	Numero massimo di risorse da includere in una singola risposta.
skip	query		integer int32	Offset nella raccolta della prima risorsa da restituire.
top	query		integer int32	Numero massimo di risorse da restituire dalla raccolta.

Risposte

Nome	Tipo	Descrizione
200 OK	TextAnalysisAuthoringProjectsMetadata	Metadati dei progetti.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Se abbinato 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 in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A 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 sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno 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 di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente Azure Active Directory v1.0 o v2.0 supporta account aziendali, dell'istituto di istruzione e guest, ma non supporta 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

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Type: apiKey
In: header

Esempio

Successful List Projects

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "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"
    },
    {
      "createdDateTime": "2022-04-18T14:03:12Z",
      "lastModifiedDateTime": "2022-04-18T14:03:12Z",
      "projectKind": "CustomMultiLabelClassification",
      "storageInputContainerName": "loanagreements",
      "projectName": "MoviesSummary",
      "multilingual": false,
      "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".",
      "language": "en"
    }
  ],
  "nextLink": null
}

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.
TextAnalysisAuthoringProjectSettings	Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.
TextAnalysisAuthoringProjectsMetadata	Rappresenta un elenco dei metadati dei progetti recuperati.

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.

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.

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 la compilazione di 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	string	Per la compilazione di 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

Rappresenta i metadati di un progetto.

Nome	Tipo	Descrizione
createdDateTime	string	Rappresenta la data/ora di creazione del progetto.
description	string	Descrizione del progetto.
language	string	Lingua del progetto. Questa è la 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	Rappresenta l'ultima data/ora dell'ultima distribuzione del progetto.
lastModifiedDateTime	string	Rappresenta l'ultima modifica del progetto datetime.
lastTrainedDateTime	string	Rappresenta l'ultima data/ora dell'ultimo training del progetto.
multilingual	boolean	Indica se il progetto verrebbe usato o meno per più lingue.
projectKind	ProjectKind	Tipo di progetto.
projectName	string	Nome del nuovo progetto.
settings	TextAnalysisAuthoringProjectSettings	Impostazioni del progetto.
storageInputContainerName	string	Nome del contenitore di archiviazione.

TextAnalysisAuthoringProjectSettings

Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

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

TextAnalysisAuthoringProjectsMetadata

Rappresenta un elenco dei metadati dei progetti recuperati.

Nome	Tipo	Descrizione
nextLink	string	Collegamento alla pagina successiva.
value	TextAnalysisAuthoringProjectMetadata[]	Elenco di progetti.

Condividi tramite