Question Answering Projects - Get Sources

Служба:

Azure AI Services

Версия API:

2021-10-01

Возвращает все источники проекта.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Имя используемого проекта.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
maxpagesize	query		integer (int32)	Максимальное количество ресурсов для включения в один ответ.
skip	query		integer (int32)	Смещение в коллекцию первого ресурса, возвращаемого.
top	query		integer (int32)	Максимальное количество ресурсов, возвращаемых из коллекции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Ответы

Имя	Тип	Описание
200 OK	QnaSources	Все источники проекта.
Other Status Codes	ErrorResponse	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful query

Образец запроса

HTTP

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaSourceRecord	Пользовательская запись источника с последней обновленной датой и временем.
QnaSources	Все источники QnA для проекта.
sourceContentStructureKind	Тип структуры контента для источников.
sourceKind	Поддерживаемые типы источников.

Error

Object

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из определяемых сервером кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Перечисление

Код ошибки, доступный для чтения человеком.

Значение	Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Объект ошибки.

InnerErrorCode

Перечисление

Код ошибки, доступный для чтения человеком.

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемых сервером кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

QnaSourceRecord

Object

Пользовательская запись источника с последней обновленной датой и временем.

Имя	Тип	Default value	Описание
contentStructureKind	sourceContentStructureKind	Unstructured	Тип структуры контента для источников.
displayName	string minLength: 1 maxLength: 200		Понятное имя источника.
lastUpdatedDateTime	string (date-time)		Дата и время последнего обновления QnA.
source	string		Уникальный идентификатор источника. Имя файла, если это источник "file"; в противном случае полный URL-адрес, если он является источником URL-адреса.
sourceKind	sourceKind	url	Поддерживаемые типы источников.
sourceUri	string (uri)		Расположение URI для файла или URL-адреса.

QnaSources

Object

Все источники QnA для проекта.

Имя	Тип	Описание
nextLink	string
value	QnaSourceRecord[]	Пользовательские источники, из которых были извлечены или явно добавлены в проект.

sourceContentStructureKind

Перечисление

Тип структуры контента для источников.

Значение	Описание
unstructured

sourceKind

Перечисление

Поддерживаемые типы источников.

Значение	Описание
file
url