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

url

Endpoint di Servizi cognitivi supportati, ad esempio https://.api.cognitiveservices.azure.com.

projectName
path True

string

Nome del nuovo progetto.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

TextAnalysisAuthoringProjectMetadata

La richiesta ha avuto esito positivo.

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

SuccessfulGetProject

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.

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
ProjectSettings

Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

TextAnalysisAuthoringProjectMetadata

Rappresenta i metadati di un 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.

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.

ProjectKind

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 il file 2 viene classificato come B e C.

CustomSingleLabelClassification

string

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.

ProjectSettings

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.

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

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

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 verrà usato o meno per più lingue.

projectKind

ProjectKind

Tipo di progetto.

projectName

string

Nome del nuovo progetto.

settings

ProjectSettings

Impostazioni del progetto.

storageInputContainerName

string

Nome del contenitore di archiviazione.