Conversational Analysis Authoring - Get Project

Dienst:

Azure AI Services

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://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	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	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	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

Objekt

Stellt die Metadaten eines Projekts dar.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Stellt das Datum und die Uhrzeit der Projekterstellung dar.
description	string	Die Projektbeschreibung.
language	string	Die Projektsprache. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
lastDeployedDateTime	string (date-time)	Stellt das Datum und die Uhrzeit der letzten Bereitstellung des Projekts dar.
lastModifiedDateTime	string (date-time)	Stellt das Datum und die Uhrzeit der Projekterstellung dar.
lastTrainedDateTime	string (date-time)	Stellt das Datum und die Uhrzeit des zuletzt trainierten Projekts 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

Objekt

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

Name	Typ	Beschreibung
confidenceThreshold	number (float)	Der Schwellenwert der Absicht mit der höchsten Konfidenz, bei dem die Vorhersage automatisch in "Keine" geändert wird.

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von 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 lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

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

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Objekt

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.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

ProjectKind

Enumeration

Stellt die Projektart dar.

Wert	Beschreibung
Conversation	Ein Projekt zur Integration natürlicher Sprache in Apps, Bots und IoT-Geräte.
Orchestration	Ein Projekt zum Verbinden und Orchestrieren von Unterhaltungen, benutzerdefinierten Fragen und LUIS-Projekten in einem einzigen Projekt.