Question Answering Projects - List Projects

Referenz

Dienst:: Cognitive Services - Language

API-Version:: 2023-04-01

Ruft alle Projekte für einen Benutzer ab.

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01

Mit optionalen Parametern:

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Client-API-Version.
maxpagesize	query		integer int32	Die maximale Anzahl von Ressourcen, die in eine einzelne Antwort eingeschlossen werden sollen.
skip	query		integer int32	Ein Offset in die Auflistung der ersten ressource, die zurückgegeben werden soll.
top	query		integer int32	Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ProjectsMetadata	Die Metadaten aller Projekte.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "projectName": "proj1",
      "description": "proj1 is a test project.",
      "language": "en",
      "multilingualResource": true,
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    },
    {
      "projectName": "proj2",
      "description": "proj2 is a test project.",
      "language": "fr",
      "multilingualResource": true,
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    }
  ]
}

Definitionen

Name	Beschreibung
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.
ProjectMetadata	Stellt das Projekt dar.
ProjectSettings	Konfigurierbare Einstellungen des Projekts.
ProjectsMetadata	Sammlung von Projektmetadaten und globalen Einstellungen.

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

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

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.

Name	Typ	Beschreibung
code	InnerErrorCode	Einer der vom Server definierten 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.

ProjectMetadata

Stellt das Projekt dar.

Name	Typ	Beschreibung
createdDateTime	string	Datum und Uhrzeit der Projekterstellung.
description	string	Beschreibung des Projekts.
language	string	Sprache der Textdatensätze. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, verwenden Sie standardmäßig "en" für Englisch.
lastDeployedDateTime	string	Stellt das Datum und die Uhrzeit der letzten Bereitstellung des Projekts dar.
lastModifiedDateTime	string	Stellt das Datum und die Uhrzeit der letzten Änderung des Projekts dar.
multilingualResource	boolean	Ressource, die projektübergreifend für mehrere Sprachen aktiviert ist oder nicht.
projectName	string	Der Name des Projekts.
settings	ProjectSettings	Konfigurierbare Einstellungen des Projekts.

ProjectSettings

Konfigurierbare Einstellungen des Projekts.

Name	Typ	Beschreibung
defaultAnswer	string	Standardantwort, wenn keine gute Übereinstimmung im Wissensdatenbank gefunden wird.

ProjectsMetadata

Sammlung von Projektmetadaten und globalen Einstellungen.

Name	Typ	Beschreibung
nextLink	string
value	ProjectMetadata[]	Stellt das Projekt dar.

Freigeben über