Conversational Analysis Authoring - Train

Referens

Tjänst:: Cognitive Services - Language

API-version:: 2022-05-01

Utlöser ett träningsjobb för ett projekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Namnet på det projekt som ska användas.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	En prenumerationsnyckel för en språktjänstresurs.

Begärandetext

Name	Obligatorisk	Typ	Description
modelLabel	True	string	Representerar utdatamodelletiketten.
trainingMode	True	TrainingMode	Representerar träningsåtgärdens läge.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Representerar utvärderingsalternativen. Som standard är utvärderingstypen procent, med träningsdelningsprocent som 80 och testning av delad procentsats som 20.
trainingConfigVersion		string	Representerar träningskonfigurationsversion. Som standard används värdet "senaste" som använder den senaste versionen av träningskonfigurationen.

Svar

Name	Typ	Description
202 Accepted		Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status. Sidhuvuden operation-location: string
Other Status Codes	ErrorResponse	Felsvar.

Name

Typ

Description

202 Accepted

Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status.

Sidhuvuden

operation-location: string

Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful Train Project

Exempelbegäran

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

Exempelsvar

Statuskod:: 202

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

Definitioner

Name	Description
ConversationalAnalysisAuthoringEvaluationOptions	Representerar de alternativ som används för att köra utvärderingen.
ConversationalAnalysisAuthoringTrainingJobOptions	Representerar alternativen för att starta ett nytt träningsjobb.
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
EvaluationKind	Representerar utvärderingstyp. Som standard är utvärderingstypen inställd på procent.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Representerar träningsåtgärdens läge.

ConversationalAnalysisAuthoringEvaluationOptions

Representerar de alternativ som används för att köra utvärderingen.

Name	Typ	Description
kind	EvaluationKind	Representerar utvärderingstyp. Som standard är utvärderingstypen inställd på procent.
testingSplitPercentage	integer	Representerar delningsprocenten för testdatauppsättningen. Behövs bara om utvärderingstyp är procent.
trainingSplitPercentage	integer	Representerar delningsprocenten för träningsdatauppsättningen. Behövs bara om utvärderingstyp är procent.

ConversationalAnalysisAuthoringTrainingJobOptions

Representerar alternativen för att starta ett nytt träningsjobb.

Name	Typ	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Representerar utvärderingsalternativen. Som standard är utvärderingstypen procent, med träningsdelningsprocent som 80 och testning av delad procentsats som 20.
modelLabel	string	Representerar utdatamodelletiketten.
trainingConfigVersion	string	Representerar träningskonfigurationsversion. Som standard används värdet "senaste" som använder den senaste versionen av träningskonfigurationen.
trainingMode	TrainingMode	Representerar träningsåtgärdens läge.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En läsbar återgivning av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

EvaluationKind

Representerar utvärderingstyp. Som standard är utvärderingstypen inställd på procent.

Name	Typ	Description
manual	string	Dela upp data enligt den valda datauppsättningen för varje exempel i data.
percentage	string	Dela upp data i tränings- och testuppsättningar enligt användardefinierade procentsatser.

InnerErrorCode

Felkod som kan läsas av människor.

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

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

TrainingMode

Representerar träningsåtgärdens läge.

Name	Typ	Description
advanced	string	Tränar med finjusterade transformatormodeller för neurala nätverk. Kan träna flerspråkiga projekt.
standard	string	Snabbare träningstider för snabbare iterationer.

Dela via

Conversational Analysis Authoring - Train

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Successful Train Project

Exempelbegäran

Exempelsvar

Definitioner

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Ytterligare resurser