Conversational Analysis Authoring - Create Project

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2022-05-01

Vytvoří nový projekt nebo aktualizuje existující projekt.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze klientského rozhraní API

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Klíč předplatného pro prostředek služby language.

Text požadavku

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

Name	Vyžadováno	Typ	Description
language	True	string	Jazyk projektu. Toto je reprezentace jazyka BCP-47. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
projectKind	True	ProjectKind	Představuje druh projektu.
projectName	True	string	Název nového projektu.
description		string	Popis projektu.
multilingual		boolean	Jestli se projekt použije pro více jazyků, nebo ne.
settings		ConversationalAnalysisAuthoringProjectSettings	Nastavení projektu.

Odpovědi

Name	Typ	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Metadata aktualizovaného projektu, pokud již existuje.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	Metadata vytvořeného projektu.
Other Status Codes	ErrorResponse	Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby language.

Typ: apiKey
V: header

Příklady

Successful Create Project

Ukázkový požadavek

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
}

Ukázková odpověď

Stavový kód:: 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"
}

Stavový kód:: 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"
}

Definice

Name	Description
ConversationalAnalysisAuthoringCreateProjectOptions	Představuje možnosti použité k vytvoření nebo aktualizaci projektu.
ConversationalAnalysisAuthoringProjectMetadata	Představuje metadata projektu.
ConversationalAnalysisAuthoringProjectSettings	Představuje nastavení použitá k definování chování projektu.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Představuje druh projektu.

ConversationalAnalysisAuthoringCreateProjectOptions

Představuje možnosti použité k vytvoření nebo aktualizaci projektu.

Name	Typ	Description
description	string	Popis projektu.
language	string	Jazyk projektu. Toto je reprezentace jazyka BCP-47. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
multilingual	boolean	Jestli se projekt použije pro více jazyků, nebo ne.
projectKind	ProjectKind	Představuje druh projektu.
projectName	string	Název nového projektu.
settings	ConversationalAnalysisAuthoringProjectSettings	Nastavení projektu.

ConversationalAnalysisAuthoringProjectMetadata

Představuje metadata projektu.

Name	Typ	Description
createdDateTime	string	Představuje datum a čas vytvoření projektu.
description	string	Popis projektu.
language	string	Jazyk projektu. Toto je reprezentace jazyka BCP-47. Použijte například "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
lastDeployedDateTime	string	Představuje datum a čas posledního nasazení projektu.
lastModifiedDateTime	string	Představuje datum a čas vytvoření projektu.
lastTrainedDateTime	string	Představuje poslední vytrénovaný projekt datetime.
multilingual	boolean	Jestli se projekt použije pro více jazyků, nebo ne.
projectKind	ProjectKind	Představuje druh projektu.
projectName	string	Název nového projektu.
settings	ConversationalAnalysisAuthoringProjectSettings	Nastavení projektu.

ConversationalAnalysisAuthoringProjectSettings

Představuje nastavení použitá k definování chování projektu.

Name	Typ	Description
confidenceThreshold	number	Prahová hodnota záměru s nejvyšší spolehlivostí, při které se předpověď automaticky změní na "Žádný".

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definované sady kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

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

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode