Conversational Analysis Authoring - Get Project

Reference

Služba:: Cognitive Services - Language

Verze rozhraní API:: 2022-05-01

Získá podrobnosti projektu.

GET {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 rozhraní API klienta.

Hlavička požadavku

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

Odpovědi

Name	Typ	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Metadata projektu.
Other Status Codes	ErrorResponse	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

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

Typ: apiKey
V: header

Příklady

Successful Get Project

Ukázkový požadavek

HTTP

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

Ukázková odpověď

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
ConversationalAnalysisAuthoringProjectMetadata	Představuje metadata projektu.
ConversationalAnalysisAuthoringProjectSettings	Představuje nastavení sloužící k definování chování projektu.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Chybová odpověď.
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.

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. Například pro angličtinu použijte "en", "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 datum a čas posledního trénovaného projektu.
multilingual	boolean	Určuje, jestli se projekt bude používat 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í sloužící 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ých chybových kódů.
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

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode