Conversational Analysis Authoring - Create Project

Referens

Tjänst:: Cognitive Services - Language

API-version:: 2022-05-01

Skapar ett nytt projekt eller uppdaterar ett befintligt.

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

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

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

Begärandetext

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

Name	Obligatorisk	Typ	Description
language	True	string	Projektspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
projectKind	True	ProjectKind	Representerar projekttypen.
projectName	True	string	Det nya projektnamnet.
description		string	Projektbeskrivningen.
multilingual		boolean	Om projektet skulle användas för flera språk eller inte.
settings		ConversationalAnalysisAuthoringProjectSettings	Projektinställningarna.

Svar

Name	Typ	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Metadata för det uppdaterade projektet, om det redan finns.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	Metadata för det skapade projektet.
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 Create Project

Exempelbegäran

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
}

Exempelsvar

Statuskod:: 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"
}

Statuskod:: 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"
}

Definitioner

Name	Description
ConversationalAnalysisAuthoringCreateProjectOptions	Representerar de alternativ som används för att skapa eller uppdatera ett projekt.
ConversationalAnalysisAuthoringProjectMetadata	Representerar metadata för ett projekt.
ConversationalAnalysisAuthoringProjectSettings	Representerar de inställningar som används för att definiera projektbeteendet.
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
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.
ProjectKind	Representerar projekttypen.

ConversationalAnalysisAuthoringCreateProjectOptions

Representerar de alternativ som används för att skapa eller uppdatera ett projekt.

Name	Typ	Description
description	string	Projektbeskrivningen.
language	string	Projektspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
multilingual	boolean	Om projektet skulle användas för flera språk eller inte.
projectKind	ProjectKind	Representerar projekttypen.
projectName	string	Det nya projektnamnet.
settings	ConversationalAnalysisAuthoringProjectSettings	Projektinställningarna.

ConversationalAnalysisAuthoringProjectMetadata

Representerar metadata för ett projekt.

Name	Typ	Description
createdDateTime	string	Representerar datumtid för projektskapande.
description	string	Projektbeskrivningen.
language	string	Projektspråket. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
lastDeployedDateTime	string	Representerar projektet som senast distribuerades datetime.
lastModifiedDateTime	string	Representerar datumtid för projektskapande.
lastTrainedDateTime	string	Representerar projektets senast tränade datetime.
multilingual	boolean	Om projektet skulle användas för flera språk eller inte.
projectKind	ProjectKind	Representerar projekttypen.
projectName	string	Det nya projektnamnet.
settings	ConversationalAnalysisAuthoringProjectSettings	Projektinställningarna.

ConversationalAnalysisAuthoringProjectSettings

Representerar de inställningar som används för att definiera projektbeteendet.

Name	Typ	Description
confidenceThreshold	number	Tröskelvärdet för avsikten med högsta konfidens, där förutsägelsen automatiskt ändras till "Ingen".

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.

InnerErrorCode