Conversational Analysis Authoring - Get Project

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2022-05-01

Pobiera szczegóły projektu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Klucz subskrypcji zasobu usługi językowej.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Metadane projektu.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful Get Project

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
ConversationalAnalysisAuthoringProjectMetadata	Reprezentuje metadane projektu.
ConversationalAnalysisAuthoringProjectSettings	Reprezentuje ustawienia używane do definiowania zachowania projektu.
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Reprezentuje rodzaj projektu.

ConversationalAnalysisAuthoringProjectMetadata

Reprezentuje metadane projektu.

Nazwa	Typ	Opis
createdDateTime	string	Reprezentuje datę/godzinę utworzenia projektu.
description	string	Opis projektu.
language	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Wielka Brytania), "es" dla języka hiszpańskiego itp.
lastDeployedDateTime	string	Reprezentuje projekt ostatnio wdrożony data/godzina.
lastModifiedDateTime	string	Reprezentuje datę/godzinę utworzenia projektu.
lastTrainedDateTime	string	Reprezentuje projekt ostatnio wytrenowany data/godzina.
multilingual	boolean	Czy projekt będzie używany w wielu językach, czy nie.
projectKind	ProjectKind	Reprezentuje rodzaj projektu.
projectName	string	Nowa nazwa projektu.
settings	ConversationalAnalysisAuthoringProjectSettings	Ustawienia projektu.

ConversationalAnalysisAuthoringProjectSettings

Reprezentuje ustawienia używane do definiowania zachowania projektu.

Nazwa	Typ	Opis
confidenceThreshold	number	Próg intencji z największą ufnością, przy której przewidywanie zostanie automatycznie zmienione na "Brak".

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode