Conversational Analysis Authoring - Train

Riferimento

Servizio:: Cognitive Services - Language

Versione API:: 2022-05-01

Attiva un processo di training per un progetto.

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?api-version=2022-05-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da usare.
api-version	query	True	string	Versione API client.

Intestazione della richiesta

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

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
modelLabel	True	string	Rappresenta l'etichetta del modello di output.
trainingMode	True	TrainingMode	Rappresenta la modalità dell'operazione di training.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Rappresenta le opzioni di valutazione. Per impostazione predefinita, il tipo di valutazione è percentuale, con percentuale di divisione del training pari a 80 e la percentuale di divisione dei test come 20.
trainingConfigVersion		string	Rappresenta la versione di configurazione del training. Per impostazione predefinita, viene usato il valore "latest" che usa la versione più recente della configurazione di training rilasciata.

Risposte

Nome	Tipo	Descrizione
202 Accepted		Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo. Intestazioni operation-location: string
Other Status Codes	ErrorResponse	Risposta di errore.

Nome

Tipo

Descrizione

202 Accepted

Risultati di una chiamata con esito positivo con un'intestazione Operation-Location utilizzata per controllare lo stato del processo.

Intestazioni

operation-location: string

Other Status Codes

ErrorResponse

Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Chiave di sottoscrizione per una risorsa del servizio lingua.

Tipo: apiKey
In: header

Esempio

Successful Train Project

Esempio di richiesta

HTTP

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:train?api-version=2022-05-01


{
  "modelLabel": "model1",
  "trainingMode": "standard",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

Risposta di esempio

Codice di stato:: 202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definizioni

Nome	Descrizione
ConversationalAnalysisAuthoringEvaluationOptions	Rappresenta le opzioni usate per l'esecuzione della valutazione.
ConversationalAnalysisAuthoringTrainingJobOptions	Rappresenta le opzioni per avviare un nuovo processo di training.
Error	Oggetto error.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
EvaluationKind	Rappresenta il tipo di valutazione. Per impostazione predefinita, il tipo di valutazione è impostato su percentuale.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Rappresenta la modalità dell'operazione di training.

ConversationalAnalysisAuthoringEvaluationOptions

Rappresenta le opzioni usate per l'esecuzione della valutazione.

Nome	Tipo	Descrizione
kind	EvaluationKind	Rappresenta il tipo di valutazione. Per impostazione predefinita, il tipo di valutazione è impostato su percentuale.
testingSplitPercentage	integer	Rappresenta la percentuale di divisione del set di dati di test. Solo necessario nel caso in cui il tipo di valutazione sia percentuale.
trainingSplitPercentage	integer	Rappresenta la percentuale di divisione del set di dati di training. Solo necessario nel caso in cui il tipo di valutazione sia percentuale.

ConversationalAnalysisAuthoringTrainingJobOptions

Rappresenta le opzioni per avviare un nuovo processo di training.

Nome	Tipo	Descrizione
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Rappresenta le opzioni di valutazione. Per impostazione predefinita, il tipo di valutazione è percentuale, con percentuale di divisione del training pari a 80 e la percentuale di divisione dei test come 20.
modelLabel	string	Rappresenta l'etichetta del modello di output.
trainingConfigVersion	string	Rappresenta la versione di configurazione del training. Per impostazione predefinita, viene usato il valore "latest" che usa la versione più recente della configurazione di training rilasciata.
trainingMode	TrainingMode	Rappresenta la modalità dell'operazione di training.

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 dall'utente.

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.

EvaluationKind

Rappresenta il tipo di valutazione. Per impostazione predefinita, il tipo di valutazione è impostato su percentuale.

Nome	Tipo	Descrizione
manual	string	Suddividere i dati in base al set di dati scelto per ogni esempio nei dati.
percentage	string	Suddividere i dati in set di training e test in base alle percentuali definite dall'utente.

InnerErrorCode

Codice di errore leggibile dall'utente.

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 per l'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 degli errori.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

TrainingMode

Rappresenta la modalità dell'operazione di training.

Nome	Tipo	Descrizione
advanced	string	Esegue il training usando modelli di trasformatore di rete neurale ottimizzati. Può eseguire il training di progetti multilingue.
standard	string	Tempi di training più rapidi per iterazioni più rapide.

Condividi tramite

Conversational Analysis Authoring - Train

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Esempio

Successful Train Project

Esempio di richiesta

Risposta di esempio

Definizioni

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Risorse aggiuntive