Question Answering Projects - Get Sources

Dienst:

Azure AI Services

API-Version:

2021-10-01

Ruft alle Quellen eines Projekts ab.

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

Mit optionalen Parametern:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?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).
projectName	path	True	string maxLength: 100	Der Name des zu verwendenden Projekts.
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	QnaSources	Alle Quellen eines Projekts.
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/proj1/sources?api-version=2021-10-01

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "displayName": "source1",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    },
    {
      "displayName": "source2",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
      "sourceKind": "file",
      "contentStructureKind": "unstructured",
      "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
      "source": "surface-guide.pdf"
    }
  ]
}

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.
QnaSourceRecord	Benutzerdefinierter Quelldatensatz mit zuletzt aktualisierter Datums- und Uhrzeitangabe.
QnaSources	Alle QnA-Quellen für das Projekt.
sourceContentStructureKind	Inhaltsstrukturtyp für Quellen.
sourceKind	Unterstützte Quelltypen.

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.

QnaSourceRecord

Objekt

Benutzerdefinierter Quelldatensatz mit zuletzt aktualisierter Datums- und Uhrzeitangabe.

Name	Typ	Standardwert	Beschreibung
contentStructureKind	sourceContentStructureKind	Unstructured	Inhaltsstrukturtyp für Quellen.
displayName	string minLength: 1 maxLength: 200		Anzeigename der Quelle.
lastUpdatedDateTime	string (date-time)		Datum und Uhrzeit der letzten Aktualisierung der QnA.
source	string		Eindeutiger Quellbezeichner. Name der Datei, wenn es sich um eine "Datei"-Quelle handelt; andernfalls die vollständige URL, wenn es sich um eine "URL"-Quelle handelt.
sourceKind	sourceKind	url	Unterstützte Quelltypen.
sourceUri	string (uri)		URI-Speicherort für die Datei oder URL.

QnaSources

Objekt

Alle QnA-Quellen für das Projekt.

Name	Typ	Beschreibung
nextLink	string
value	QnaSourceRecord[]	Benutzerdefinierte Quellen, aus denen QnAs extrahiert oder explizit dem Projekt hinzugefügt wurden.

sourceContentStructureKind

Enumeration

Inhaltsstrukturtyp für Quellen.

Wert	Beschreibung
unstructured

sourceKind

Enumeration

Unterstützte Quelltypen.

Wert	Beschreibung
file
url