Question Answering Projects - List Projects

Dienst:

Azure AI Services

API-Version:

2021-10-01

Ruft alle Projekte für einen Benutzer ab.

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-01

Mit optionalen Parametern:

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-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 der Auflistung der ersten zurückzugebenden Ressource.
top	query		integer (int32)	Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Antworten

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

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

HTTP

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-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	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.
ProjectMetadata	Stellt das Projekt dar.
ProjectSettings	Konfigurierbare Einstellungen des Projekts.
ProjectsMetadata	Sammlung von Projektmetadaten und globalen Einstellungen.

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
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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.

ProjectMetadata

Objekt

Stellt das Projekt dar.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Datum und Uhrzeit der Projekterstellung.
description	string	Beschreibung des Projekts.
language	string	Sprache der Texteinträge. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, verwenden Sie "en" für Englisch als Standard.
lastDeployedDateTime	string (date-time)	Represents the project last deployment date-time.
lastModifiedDateTime	string (date-time)	Stellt das Datum und die Uhrzeit der letzten Änderung des Projekts dar.
multilingualResource	boolean	Ressource für mehrere Sprachen in Projekten aktiviert oder nicht.
projectName	string	Name des Projekts.
settings	ProjectSettings	Konfigurierbare Einstellungen des Projekts.

ProjectSettings

Objekt

Konfigurierbare Einstellungen des Projekts.

Name	Typ	Beschreibung
defaultAnswer	string	Standardantwortantwort, wenn keine gute Übereinstimmung in der Wissensdatenbank gefunden wird.

ProjectsMetadata

Objekt

Sammlung von Projektmetadaten und globalen Einstellungen.

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