Conversational Analysis Authoring - Get Project

Usługa:

Azure AI Services

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://< nazwa-zasobu.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	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 dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Reprezentuje rodzaj projektu.

ConversationalAnalysisAuthoringProjectMetadata

Objekt

Reprezentuje metadane projektu.

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Reprezentuje datę i godzinę utworzenia projektu.
description	string	Opis projektu.
language	string	Język projektu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
lastDeployedDateTime	string (date-time)	Reprezentuje datę i godzinę ostatniego wdrożenia projektu.
lastModifiedDateTime	string (date-time)	Reprezentuje datę i godzinę utworzenia projektu.
lastTrainedDateTime	string (date-time)	Reprezentuje projekt z ostatnią wygenerowaną datą i godziną.
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

Objekt

Reprezentuje ustawienia używane do definiowania zachowania projektu.

Nazwa	Typ	Opis
confidenceThreshold	number (float)	Próg intencji z najwyższym poziomem ufności, przy którym przewidywanie zostanie automatycznie zmienione na "Brak".

Error

Objekt

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

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ProjectKind

Wyliczanie

Reprezentuje rodzaj projektu.

Wartość	Opis
Conversation	Projekt tworzenia języka naturalnego w aplikacjach, botach i urządzeniach IoT.
Orchestration	Projekt do łączenia i organizowania konwersacji, niestandardowych odpowiedzi na pytania i projektów LUIS w jednym projekcie.