Conversational Analysis Authoring - Train

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2022-05-01

Wyzwala zadanie szkoleniowe dla projektu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz subskrypcji zasobu usługi językowej.

Treść żądania

Nazwa	Wymagane	Typ	Opis
modelLabel	True	string	Reprezentuje etykietę modelu wyjściowego.
trainingMode	True	TrainingMode	Reprezentuje tryb operacji trenowania.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Reprezentuje opcje oceny. Domyślnie rodzaj oceny to wartość procentowa, z wartością procentową podziału trenowania na wartość 80, a wartość procentowa podziału testowania wynosi 20.
trainingConfigVersion		string	Reprezentuje wersję konfiguracji trenowania. Domyślnie używana jest "najnowsza" wartość, która używa najnowszej wersji konfiguracji trenowania.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania. Nagłówki operation-location: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Nazwa

Typ

Opis

202 Accepted

Wyniki pomyślnego wywołania z nagłówkiem Operation-Location służącym do sprawdzania stanu zadania.

Nagłówki

operation-location: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful Train Project

Przykładowe żądanie

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
  }
}

Przykładowa odpowiedź

Kod stanu:: 202

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

Definicje

Nazwa	Opis
ConversationalAnalysisAuthoringEvaluationOptions	Reprezentuje opcje używane podczas uruchamiania oceny.
ConversationalAnalysisAuthoringTrainingJobOptions	Reprezentuje opcje uruchamiania nowego zadania szkoleniowego.
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
EvaluationKind	Reprezentuje rodzaj oceny. Domyślnie typ oceny jest ustawiony na wartość procentową.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Reprezentuje tryb operacji trenowania.

ConversationalAnalysisAuthoringEvaluationOptions

Reprezentuje opcje używane podczas uruchamiania oceny.

Nazwa	Typ	Opis
kind	EvaluationKind	Reprezentuje rodzaj oceny. Domyślnie typ oceny jest ustawiony na wartość procentową.
testingSplitPercentage	integer	Reprezentuje procent podziału zestawu danych testowania. Tylko w przypadku, gdy rodzaj oceny jest procentem.
trainingSplitPercentage	integer	Reprezentuje procent podziału zestawu danych trenowania. Tylko w przypadku, gdy rodzaj oceny jest procentem.

ConversationalAnalysisAuthoringTrainingJobOptions

Reprezentuje opcje uruchamiania nowego zadania szkoleniowego.

Nazwa	Typ	Opis
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Reprezentuje opcje oceny. Domyślnie rodzaj oceny to wartość procentowa, z wartością procentową podziału trenowania na wartość 80, a wartość procentowa podziału testowania wynosi 20.
modelLabel	string	Reprezentuje etykietę modelu wyjściowego.
trainingConfigVersion	string	Reprezentuje wersję konfiguracji trenowania. Domyślnie używana jest "najnowsza" wartość, która używa najnowszej wersji konfiguracji trenowania.
trainingMode	TrainingMode	Reprezentuje tryb operacji trenowania.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

EvaluationKind

Reprezentuje rodzaj oceny. Domyślnie typ oceny jest ustawiony na wartość procentową.

Nazwa	Typ	Opis
manual	string	Podziel dane zgodnie z wybranym zestawem danych dla każdego przykładu danych.
percentage	string	Podziel dane na zestawy treningowe i testowe zgodnie z wartościami procentowymi zdefiniowanymi przez użytkownika.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Błąd docelowy.

TrainingMode

Reprezentuje tryb operacji trenowania.

Nazwa	Typ	Opis
advanced	string	Trenuje przy użyciu dostosowanych modeli przekształcania sieci neuronowej. Może trenować projekty wielojęzyczne.
standard	string	Szybsze czasy trenowania na potrzeby szybszych iteracji.

Udostępnij za pośrednictwem

Conversational Analysis Authoring - Train

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Successful Train Project

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Dodatkowe zasoby