Text Analysis Authoring - Train

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2022-05-01

Aktivuje trénovací úlohu pro projekt.

POST {Endpoint}/language/authoring/analyze-text/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 maxLength: 100	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.
trainingConfigVersion	True	string	Představuje verzi trénovací konfigurace.
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	Představuje možnosti vyhodnocení. Ve výchozím nastavení je druh vyhodnocení procento s procentuálním rozdělením trénování jako 80 a procento rozdělení testování jako 20.

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-text/projects/LoanAgreements/:train?api-version=2022-05-01


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

Ukázková odpověď

Stavový kód:: 202

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

Definice

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

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
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, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

EvaluationKind

Výčet

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

Hodnota	Description
manual	Rozdělte data podle zvolené datové sady pro každý příklad v datech.
percentage	Data rozdělte do trénovacích a testovacích sad podle uživatelsky definovaných procent.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Objekt

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

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

TextAnalysisAuthoringEvaluationOptions

Objekt

Představuje možnosti použité při spuštění vyhodnocení.

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