Conversational Analysis Authoring - Train

Referentie

Service:: Cognitive Services - Language

API-versie:: 2022-05-01

Hiermee wordt een trainingstaak voor een project geactiveerd.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string	De naam van het project dat moet worden gebruikt.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een taalserviceresource.

Aanvraagbody

Name	Vereist	Type	Description
modelLabel	True	string	Vertegenwoordigt het label van het uitvoermodel.
trainingMode	True	TrainingMode	Vertegenwoordigt de modus van de trainingsbewerking.
evaluationOptions		ConversationalAnalysisAuthoringEvaluationOptions	Vertegenwoordigt de evaluatieopties. Standaard is het type evaluatie percentage, met het gesplitste percentage van de training op 80 en het testsplitpercentage op 20.
trainingConfigVersion		string	Vertegenwoordigt de configuratieversie van de training. Standaard wordt de waarde 'meest recente' gebruikt die gebruikmaakt van de meest recente versie van de trainingsconfiguratie.

Antwoorden

Name	Type	Description
202 Accepted		Een geslaagde aanroep resulteert in een Operation-Location-header die wordt gebruikt om de status van de taak te controleren. Kopteksten operation-location: string
Other Status Codes	ErrorResponse	Foutreactie.

Name

Type

Description

202 Accepted

Een geslaagde aanroep resulteert in een Operation-Location-header die wordt gebruikt om de status van de taak te controleren.

Kopteksten

operation-location: string

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Train Project

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 202

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

Definities

Name	Description
ConversationalAnalysisAuthoringEvaluationOptions	Vertegenwoordigt de opties die worden gebruikt om de evaluatie uit te voeren.
ConversationalAnalysisAuthoringTrainingJobOptions	Vertegenwoordigt de opties voor het starten van een nieuwe trainingstaak.
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
EvaluationKind	Vertegenwoordigt het type evaluatie. Het type evaluatie is standaard ingesteld op percentage.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TrainingMode	Vertegenwoordigt de modus van de trainingsbewerking.

ConversationalAnalysisAuthoringEvaluationOptions

Vertegenwoordigt de opties die worden gebruikt om de evaluatie uit te voeren.

Name	Type	Description
kind	EvaluationKind	Vertegenwoordigt het type evaluatie. Het type evaluatie is standaard ingesteld op percentage.
testingSplitPercentage	integer	Vertegenwoordigt het gesplitste percentage van de testgegevensset. Alleen nodig als het type evaluatie percentage is.
trainingSplitPercentage	integer	Vertegenwoordigt het gesplitste percentage van de trainingsgegevensset. Alleen nodig als het type evaluatie percentage is.

ConversationalAnalysisAuthoringTrainingJobOptions

Vertegenwoordigt de opties voor het starten van een nieuwe trainingstaak.

Name	Type	Description
evaluationOptions	ConversationalAnalysisAuthoringEvaluationOptions	Vertegenwoordigt de evaluatieopties. Standaard is het type evaluatie percentage, met het gesplitste percentage van de training op 80 en het testsplitpercentage op 20.
modelLabel	string	Vertegenwoordigt het label van het uitvoermodel.
trainingConfigVersion	string	Vertegenwoordigt de configuratieversie van de training. Standaard wordt de waarde 'meest recente' gebruikt die gebruikmaakt van de meest recente versie van de trainingsconfiguratie.
trainingMode	TrainingMode	Vertegenwoordigt de modus van de trainingsbewerking.

Error

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

EvaluationKind

Vertegenwoordigt het type evaluatie. Het type evaluatie is standaard ingesteld op percentage.

Name	Type	Description
manual	string	Splits de gegevens op basis van de gekozen gegevensset voor elk voorbeeld in de gegevens.
percentage	string	Splits de gegevens in trainings- en testsets op basis van door de gebruiker gedefinieerde percentages.

InnerErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

TrainingMode

Vertegenwoordigt de modus van de trainingsbewerking.

Name	Type	Description
advanced	string	Traint met behulp van nauwkeurig afgestemde neurale netwerktransformatormodellen. Kan meertalige projecten trainen.
standard	string	Snellere trainingstijden voor snellere iteraties.

Delen via

Conversational Analysis Authoring - Train

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

Successful Train Project

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ConversationalAnalysisAuthoringEvaluationOptions

ConversationalAnalysisAuthoringTrainingJobOptions

Error

ErrorCode

ErrorResponse

EvaluationKind

InnerErrorCode

InnerErrorModel

TrainingMode

Aanvullende resources