Conversational Analysis Authoring - Get Project

Servizio:

Azure AI Services

Versione API:

2022-05-01

Ottiene i dettagli di un progetto.

GET {Endpoint}/language/authoring/analyze-conversations/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://< nome-risorsa.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	Una chiave di sottoscrizione per una risorsa del servizio di linguaggio.

Risposte

Nome	Tipo	Descrizione
200 OK	ConversationalAnalysisAuthoringProjectMetadata	I metadati del progetto.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Una 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-conversations/projects/myproject?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": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definizioni

Nome	Descrizione
ConversationalAnalysisAuthoringProjectMetadata	Rappresenta i metadati di un progetto.
ConversationalAnalysisAuthoringProjectSettings	Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.
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	Rappresenta il tipo di progetto.

ConversationalAnalysisAuthoringProjectMetadata

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 e ora di distribuzione del progetto.
lastModifiedDateTime	string (date-time)	Rappresenta la data/ora di creazione del progetto.
lastTrainedDateTime	string (date-time)	Rappresenta l'ultima data e ora di training del progetto.
multilingual	boolean	Indica se il progetto verrà usato o meno per più lingue.
projectKind	ProjectKind	Rappresenta il tipo di progetto.
projectName	string	Nome del nuovo progetto.
settings	ConversationalAnalysisAuthoringProjectSettings	Impostazioni del progetto.

ConversationalAnalysisAuthoringProjectSettings

Object

Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

Nome	Tipo	Descrizione
confidenceThreshold	number (float)	Soglia dell'intento con l'attendibilità più alta, in corrispondenza della quale la stima verrà automaticamente modificata in "Nessuna".

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
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

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

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

Rappresenta il tipo di progetto.

Valore	Descrizione
Conversation	Un progetto per creare un linguaggio naturale in app, bot e dispositivi IoT.
Orchestration	Un progetto per connettere e orchestrare contemporaneamente in un unico progetto Conversazione, Risposta alle domande personalizzata e progetti LUIS.