Question Answering Projects - Get Sources

Usługa:

Azure AI Services

Wersja interfejsu API:

2021-10-01

Pobiera wszystkie źródła projektu.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.
maxpagesize	query		integer (int32)	Maksymalna liczba zasobów do uwzględnienia w pojedynczej odpowiedzi.
skip	query		integer (int32)	Przesunięcie do kolekcji pierwszego zasobu, który ma zostać zwrócony.
top	query		integer (int32)	Maksymalna liczba zasobów do zwrócenia z kolekcji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QnaSources	Wszystkie źródła projektu.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful query

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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"
    }
  ]
}

Definicje

Nazwa	Opis
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaSourceRecord	Niestandardowy rekord źródłowy z ostatnią zaktualizowaną datą i godziną.
QnaSources	Wszystkie źródła pytań i pytań i pytań i pytań dla projektu.
sourceContentStructureKind	Typ struktury zawartości dla źródeł.
sourceKind	Obsługiwane typy źródłowe.

Error

Objekt

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

QnaSourceRecord

Objekt

Niestandardowy rekord źródłowy z ostatnią zaktualizowaną datą i godziną.

Nazwa	Typ	Domyślna wartość	Opis
contentStructureKind	sourceContentStructureKind	Unstructured	Typ struktury zawartości dla źródeł.
displayName	string minLength: 1 maxLength: 200		Przyjazna nazwa źródła.
lastUpdatedDateTime	string (date-time)		Data i godzina ostatniej aktualizacji pytań i pytań i pytań.
source	string		Unikatowy identyfikator źródła. Nazwa pliku, jeśli jest źródłem "plik"; w przeciwnym razie pełny adres URL, jeśli jest źródłem "url".
sourceKind	sourceKind	url	Obsługiwane typy źródłowe.
sourceUri	string (uri)		Lokalizacja identyfikatora URI dla pliku lub adresu URL.

QnaSources

Objekt

Wszystkie źródła pytań i pytań i pytań i pytań dla projektu.

Nazwa	Typ	Opis
nextLink	string
value	QnaSourceRecord[]	Źródła niestandardowe, z których zostały wyodrębnione lub jawnie dodane do projektu.

sourceContentStructureKind

Wyliczanie

Typ struktury zawartości dla źródeł.

Wartość	Opis
unstructured

sourceKind

Wyliczanie

Obsługiwane typy źródłowe.

Wartość	Opis
file
url