Conversational Analysis Authoring - Get Project

Služba:

Azure AI Services

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://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	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í použitá k definování chování projektu.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Představuje druh projektu.

ConversationalAnalysisAuthoringProjectMetadata

Objekt

Představuje metadata projektu.

Name	Typ	Description
createdDateTime	string (date-time)	Představuje datum a čas vytvoření projektu.
description	string	Popis projektu.
language	string	Jazyk projektu. Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu, "en-gb" pro angličtinu (UK), "es" pro španělštinu atd.
lastDeployedDateTime	string (date-time)	Představuje datum a čas posledního nasazení projektu.
lastModifiedDateTime	string (date-time)	Představuje datum a čas vytvoření projektu.
lastTrainedDateTime	string (date-time)	Představuje datum a čas posledního naučení projektu.
multilingual	boolean	Bez ohledu na to, 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

Objekt

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

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

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných 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, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby

ProjectKind

Výčet

Představuje druh projektu.

Hodnota	Description
Conversation	Projekt na zabudování přirozeného jazyka do aplikací, robotů a zařízení IoT.
Orchestration	Projekt pro propojení a orchestraci projektů Conversation, Custom Question Answering a LUIS do jednoho projektu.