Question Answering Projects - List Projects

Dienst:: Azure AI Services

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 (uri)	Unterstützter Cognitive Services-Endpunkt (z. B. https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
maxpagesize	query		integer (int32)	Die maximale Anzahl von Ressourcen, die in einer einzelnen Antwort enthalten sein 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.

Antworten

Name	Typ	Beschreibung
200 OK	PagedQuestionAnsweringProjectMetadata	Die Anforderung war erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

PagedQuestionAnsweringProjectMetadata

Die Anforderung war erfolgreich.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

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

Bereiche

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

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

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.
PagedQuestionAnsweringProjectMetadata	Ausgelagerte Auflistung von QuestionAnsweringProjectMetadata-Elementen
ProjectSettings	Konfigurierbare Einstellungen des Projekts.
QuestionAnsweringProjectMetadata	Stellt das Projekt dar.

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	Ungültiger Anforderungsfehler
InvalidArgument	Ungültiger Argumentfehler
Unauthorized	Fehler beim nicht autorisierten Zugriff
Forbidden	Fehler beim unzulässigen Zugriff
NotFound	Fehler nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
OperationNotFound	Fehler beim Vorgang nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
TooManyRequests	Fehler bei zu vielen Anforderungen
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search Index limit reached error
InternalServerError	Interner Serverfehler
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
QuotaExceeded	Fehler "Kontingent überschritten"
Conflict	Konfliktfehler
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
InvalidRequest	Ungültiger Anforderungsfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
EmptyRequest	Fehler "Leere Anforderung"
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
InvalidDocument	Ungültiger Dokumentfehler
ModelVersionIncorrect	Fehler bei der Modellversion
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode
InvalidCountryHint	Ungültiger Fehler im Landhinweis

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.

PagedQuestionAnsweringProjectMetadata

Objekt

Ausgelagerte Auflistung von QuestionAnsweringProjectMetadata-Elementen

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	QuestionAnsweringProjectMetadata[]	Die QuestionAnsweringProjectMetadata-Elemente auf dieser Seite

ProjectSettings

Objekt

Konfigurierbare Einstellungen des Projekts.

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

QuestionAnsweringProjectMetadata

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)	Stellt das Datum und die Uhrzeit der letzten Bereitstellung des Projekts dar.
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 maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Der Name des Projekts.
settings	ProjectSettings	Konfigurierbare Einstellungen des Projekts.

Freigeben über

Question Answering Projects - List Projects

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Successful query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

PagedQuestionAnsweringProjectMetadata

ProjectSettings

QuestionAnsweringProjectMetadata