Conversational Analysis Authoring - Train

Referens

Tjänst:: Cognitive Services - Language

API-version:: 2023-04-01

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

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:train?api-version=2023-04-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ä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 procentandel som 20.
trainingConfigVersion		string	Representerar träningskonfigurationsversion. Som standard används det "senaste" värdet som använder den senaste utgivna träningskonfigurationsversionen.

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

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till en eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från Maps Management-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Den rollbaserade Azure-åtkomstkontrollen konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

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=2023-04-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=2023-04-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 Microsoft One API-riktlinjer – 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 den delade procentandelen för testdatamängden. 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.