Conversational Analysis Authoring - Create Project

Riferimento

Servizio:: Azure AI Services

Versione API:: 2023-04-01

Crea un nuovo progetto o ne aggiorna uno esistente.

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2023-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string
projectName	path	True	string	Nome del nuovo progetto.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Media Types: "application/merge-patch+json"

Nome	Necessario	Tipo	Descrizione
language	True	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.
projectKind	True	ProjectKind	Rappresenta il tipo di progetto.
projectName	True	string	Nome del nuovo progetto.
description		string	Descrizione del progetto.
multilingual		boolean	Indica se il progetto verrà usato o meno per più lingue.
settings		ConversationalAnalysisAuthoringProjectSettings	Impostazioni del progetto.

Risposte

Nome	Tipo	Descrizione
200 OK	ConversationalAnalysisAuthoringProjectMetadata	La richiesta ha avuto esito positivo.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa.
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

Successful Create Project

Esempio di richiesta

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2023-04-01

{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

Risposta di esempio

Codice di stato:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

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
ConversationalAnalysisAuthoringCreateProjectOptions	Rappresenta le opzioni utilizzate per creare o aggiornare un progetto.
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

ConversationalAnalysisAuthoringCreateProjectOptions

Rappresenta le opzioni utilizzate per creare o aggiornare un progetto.

Nome	Tipo	Descrizione
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.
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.

ConversationalAnalysisAuthoringProjectMetadata

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 distribuita del progetto.
lastModifiedDateTime	string	Rappresenta la data/ora di creazione del progetto.
lastTrainedDateTime	string	Rappresenta l'ultimo oggetto datetime sottoposto a 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

Rappresenta le impostazioni utilizzate per definire il comportamento del progetto.

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

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