Conversational Analysis Authoring - Create Project

Referentie

Service:: Cognitive Services - Language

API-versie:: 2022-05-01

Hiermee maakt u een nieuw project of werkt u een bestaand project bij.

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?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

Media Types: "application/merge-patch+json"

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

Aanvraagbody

Media Types: "application/merge-patch+json"

Name	Vereist	Type	Description
language	True	string	De projecttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
projectKind	True	ProjectKind	Vertegenwoordigt het soort project.
projectName	True	string	De nieuwe projectnaam.
description		string	De projectbeschrijving.
multilingual		boolean	Of het project voor meerdere talen wordt gebruikt of niet.
settings		ConversationalAnalysisAuthoringProjectSettings	De projectinstellingen.

Antwoorden

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	De metagegevens van het bijgewerkte project, als dit al bestaat.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	De metagegevens van het gemaakte project.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Create Project

Voorbeeldaanvraag

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01


{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

Voorbeeldrespons

Statuscode:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Statuscode:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definities

Name	Description
ConversationalAnalysisAuthoringCreateProjectOptions	Vertegenwoordigt de opties die worden gebruikt om een project te maken of bij te werken.
ConversationalAnalysisAuthoringProjectMetadata	Vertegenwoordigt de metagegevens van een project.
ConversationalAnalysisAuthoringProjectSettings	Vertegenwoordigt de instellingen die worden gebruikt om het gedrag van het project te definiëren.
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
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.
ProjectKind	Vertegenwoordigt het soort project.

ConversationalAnalysisAuthoringCreateProjectOptions

Vertegenwoordigt de opties die worden gebruikt om een project te maken of bij te werken.

Name	Type	Description
description	string	De projectbeschrijving.
language	string	De projecttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
multilingual	boolean	Of het project voor meerdere talen wordt gebruikt of niet.
projectKind	ProjectKind	Vertegenwoordigt het soort project.
projectName	string	De nieuwe projectnaam.
settings	ConversationalAnalysisAuthoringProjectSettings	De projectinstellingen.

ConversationalAnalysisAuthoringProjectMetadata

Vertegenwoordigt de metagegevens van een project.

Name	Type	Description
createdDateTime	string	Vertegenwoordigt de datum waarop het project is gemaakt.
description	string	De projectbeschrijving.
language	string	De projecttaal. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels, 'en-gb' voor Engels (VK), 'es' voor Spaans, enzovoort.
lastDeployedDateTime	string	Vertegenwoordigt de datum/tijd van het project dat het laatst is geïmplementeerd.
lastModifiedDateTime	string	Vertegenwoordigt de datum waarop het project is gemaakt.
lastTrainedDateTime	string	Vertegenwoordigt de datum/tijd van het project dat het laatst is getraind.
multilingual	boolean	Of het project voor meerdere talen wordt gebruikt of niet.
projectKind	ProjectKind	Vertegenwoordigt het soort project.
projectName	string	De nieuwe projectnaam.
settings	ConversationalAnalysisAuthoringProjectSettings	De projectinstellingen.

ConversationalAnalysisAuthoringProjectSettings

Vertegenwoordigt de instellingen die worden gebruikt om het gedrag van het project te definiëren.

Name	Type	Description
confidenceThreshold	number	De drempelwaarde van de intentie met de hoogste betrouwbaarheid, waarbij de voorspelling automatisch wordt gewijzigd in 'Geen'.

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.

InnerErrorCode