Conversational Analysis Authoring - Train

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2022-05-01

Aktivuje trénovací úlohu pro projekt.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Klíč předplatného pro prostředek služby jazyka.

Text požadavku

Name	Vyžadováno	Typ	Description
modelLabel	True	string	Představuje popisek výstupního modelu.
trainingMode	True	TrainingMode	Představuje režim trénovací operace.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Představuje možnosti vyhodnocení. Ve výchozím nastavení je druh vyhodnocení procento, procento rozdělení trénování je 80 a procento rozdělení testování je 20.
trainingConfigVersion		string	Představuje verzi trénovací konfigurace. Ve výchozím nastavení se používá hodnota "nejnovější", která používá nejnovější vydanou verzi trénovací konfigurace.

Odpovědi

Name	Typ	Description
202 Accepted		Výsledky úspěšného volání s hlavičkou Operation-Location sloužící ke kontrole stavu úlohy. Hlavičky operation-location: string
Other Status Codes	ErrorResponse	Chybová odpověď.

Name

Typ

Description

202 Accepted

Výsledky úspěšného volání s hlavičkou Operation-Location sloužící ke kontrole stavu úlohy.

Hlavičky

operation-location: string

Other Status Codes

ErrorResponse

Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby jazyka.

Typ: apiKey
V: header

Příklady

Successful Train Project

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 202

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

Definice

Name	Description
ConversationalAnalysisAuthoringEvaluationOptions	Představuje možnosti použité při vyhodnocování.
ConversationalAnalysisAuthoringTrainingJobOptions	Představuje možnosti pro spuštění nové úlohy trénování.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Chybová odpověď.
EvaluationKind	Představuje druh vyhodnocení. Ve výchozím nastavení je druh vyhodnocení nastavený na procenta.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Představuje režim trénovací operace.

ConversationalAnalysisAuthoringEvaluationOptions

Představuje možnosti použité při vyhodnocování.

Name	Typ	Description
kind	EvaluationKind	Představuje druh vyhodnocení. Ve výchozím nastavení je druh vyhodnocení nastavený na procenta.
testingSplitPercentage	integer	Představuje procento rozdělení testovací datové sady. Pouze v případě, že druh vyhodnocení je procentuálně.
trainingSplitPercentage	integer	Představuje procento rozdělení trénovací datové sady. Pouze v případě, že druh vyhodnocení je procentuálně.

ConversationalAnalysisAuthoringTrainingJobOptions

Představuje možnosti pro spuštění nové úlohy trénování.

Name	Typ	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Představuje možnosti vyhodnocení. Ve výchozím nastavení je druh vyhodnocení procento, procento rozdělení trénování je 80 a procento rozdělení testování je 20.
modelLabel	string	Představuje popisek výstupního modelu.
trainingConfigVersion	string	Představuje verzi trénovací konfigurace. Ve výchozím nastavení se používá hodnota "nejnovější", která používá nejnovější vydanou verzi trénovací konfigurace.
trainingMode	TrainingMode	Představuje režim trénovací operace.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definovaných chybových kódů.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
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

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

EvaluationKind

Představuje druh vyhodnocení. Ve výchozím nastavení je druh vyhodnocení nastavený na procenta.

Name	Typ	Description
manual	string	Rozdělte data podle zvolené datové sady pro každý příklad v datech.
percentage	string	Rozdělte data na trénovací a testovací sadu podle procentuálních hodnot definovaných uživatelem.

InnerErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
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

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jeden ze serverem definovaných chybových kódů.
details	object	Podrobnosti o chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Chybová zpráva.
target	string	Cíl chyby.

TrainingMode

Představuje režim trénovací operace.

Name	Typ	Description
advanced	string	Trénuje pomocí jemně vyladěných modelů transformátorů neurální sítě. Může trénovat vícejazyčné projekty.
standard	string	Rychlejší trénování pro rychlejší iterace

Sdílet prostřednictvím

Conversational Analysis Authoring - Train

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Successful Train Project

Ukázkový požadavek

Ukázková odpověď

Definice

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Další materiály