Conversational Analysis Authoring - Get Project

Referenz

Dienst:: Cognitive Services - Language

API-Version:: 2022-05-01

Ruft die Details eines Projekts ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Der Name des zu verwendenden Projekts.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Ein Abonnementschlüssel für eine Sprachdienstressource.

Antworten

Name	Typ	Beschreibung
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Die Metadaten des Projekts.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful Get Project

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
ConversationalAnalysisAuthoringProjectMetadata	Stellt die Metadaten eines Projekts dar.
ConversationalAnalysisAuthoringProjectSettings	Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.
Error	Das Fehlerobjekt.
ErrorCode	Für Menschen lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Für Menschen lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Stellt die Projektart dar.

ConversationalAnalysisAuthoringProjectMetadata

Stellt die Metadaten eines Projekts dar.

Name	Typ	Beschreibung
createdDateTime	string	Stellt die Projekterstellung datetime dar.
description	string	Die Projektbeschreibung.
language	string	Die Projektsprache. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
lastDeployedDateTime	string	Stellt das Projekt dar, das zuletzt datetime bereitgestellt wurde.
lastModifiedDateTime	string	Stellt die Projekterstellung datetime dar.
lastTrainedDateTime	string	Stellt das projekt zuletzt trainierte datetime dar.
multilingual	boolean	Gibt an, ob das Projekt für mehrere Sprachen verwendet wird oder nicht.
projectKind	ProjectKind	Stellt die Projektart dar.
projectName	string	Der neue Projektname.
settings	ConversationalAnalysisAuthoringProjectSettings	Die Projekteinstellungen.

ConversationalAnalysisAuthoringProjectSettings

Stellt die Einstellungen dar, die zum Definieren des Projektverhaltens verwendet werden.

Name	Typ	Beschreibung
confidenceThreshold	number	Der Schwellenwert der Absicht mit der höchsten Vertrauenswürdigkeit, bei der die Vorhersage automatisch in "Keine" geändert wird.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer der vom Server definierten Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
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

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode