Text Analysis Authoring - Train

Szolgáltatás:

Azure AI Services

API-verzió:

2023-04-01

Egy projekt betanítási feladatának aktiválása.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:train?api-version=2023-04-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string url	Támogatott Cognitive Services-végpont (például https://.api.cognitiveservices.azure.com).
projectName	path	True	string	A használni kívánt projekt neve.
api-version	query	True	string	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
modelLabel	True	string	A kimeneti modell címkéjét jelöli.
trainingConfigVersion	True	string	A betanítási konfiguráció verzióját jelöli.
evaluationOptions		EvaluationOptions	A kiértékelési lehetőségeket jelöli. Alapértelmezés szerint a kiértékelési típus százalékos, a betanítási felosztás százalékos értéke 80, a tesztelési felosztás százalékos értéke pedig 20.

Válaszok

Name	Típus	Description
202 Accepted		A kérelem feldolgozásra lett elfogadva, de a feldolgozás még nem fejeződött be. Fejlécek Operation-Location: string
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

Name	Description
https://cognitiveservices.azure.com/.default

Példák

SuccessfulTrainProject

Mintakérelem

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2023-04-01

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

Mintaválasz

Állapotkód:

202

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

Definíciók

Name	Description
Error	A hibaobjektum.
ErrorCode	Ember által olvasható hibakód.
ErrorResponse	Hibaválasz.
EvaluationKind
EvaluationOptions	A kiértékelés futtatásához használt beállításokat jelöli.
InnerErrorCode	Ember által olvasható hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingJobOptions	Az új betanítási feladat indításának lehetőségeit jelöli.

Error

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

ErrorCode

Ember által olvasható hibakód.

Name	Típus	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

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

EvaluationKind

Name	Típus	Description
manual	string	Ossza fel az adatokat a választott adatkészlet szerint az adatok minden példájához.
percentage	string	Ossza fel az adatokat betanítási és tesztelési csoportokra a felhasználó által meghatározott százalékok szerint.

EvaluationOptions

A kiértékelés futtatásához használt beállításokat jelöli.

Name	Típus	Description
kind	EvaluationKind	A kiértékelési típust jelöli. Alapértelmezés szerint a kiértékelési típus százalékos értékre van állítva.
testingSplitPercentage	integer	A tesztelési adathalmaz felosztási százalékos arányát jelöli. Csak akkor van szükség, ha a kiértékelési típus százalékos.
trainingSplitPercentage	integer	A betanítási adathalmaz felosztási százalékos arányát jelöli. Csak akkor van szükség, ha a kiértékelési típus százalékos.

InnerErrorCode

Ember által olvasható hibakód.

Name	Típus	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

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

TrainingJobOptions

Az új betanítási feladat indításának lehetőségeit jelöli.

Name	Típus	Description
evaluationOptions	EvaluationOptions	A kiértékelési lehetőségeket jelöli. Alapértelmezés szerint a kiértékelési típus százalékos, a betanítási felosztás százalékos értéke 80, a tesztelési felosztás százalékos értéke pedig 20.
modelLabel	string	A kimeneti modell címkéjét jelöli.
trainingConfigVersion	string	A betanítási konfiguráció verzióját jelöli.