Question Answering Projects - Get Sources

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-15-preview

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

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-15-preview

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

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-15-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}

Параметры URI

Имя	В	Обязательно	Тип	Описание
projectName	path	True	string	Имя используемого проекта.
api-version	query	True	string	Версия КЛИЕНТСКОго API.
maxpagesize	query		integer int32	Максимальное количество ресурсов для включения в один ответ.
skip	query		integer int32	Смещение в коллекцию первого ресурса, возвращаемого.
top	query		integer int32	Максимальное количество ресурсов, возвращаемых из коллекции.

Ответы

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

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

AADToken

Это потоки OAuth2 Azure Active Directory. При паре с доступом на основе ролей Azure его можно использовать для управления доступом к REST API Azure Maps. Управление доступом на основе ролей Azure используется для назначения доступа к одной или нескольким учетным записям ресурсов Azure Maps или вложенным ресурсам. Доступ к любому пользователю, группе или субъекту-службе можно предоставить через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений для REST API Azure Maps.

Для реализации сценариев рекомендуется просматривать концепции проверки подлинности . В целом, это определение безопасности предоставляет решение для моделирования приложений через объекты, способные управлять доступом в определенных API и областях.

Примечания

Для этого определения безопасности требуется использовать заголовок x-ms-client-id, чтобы указать, к какой ресурсу Azure Maps приложение запрашивает доступ. Это можно получить изAPI управления картами .

Authorization URL зависит от экземпляра общедоступного облака Azure. В национальных облаках есть уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается с плоскости управления Azure с помощью портала Azure, PowerShell, CLI, пакетов SDK Azure или REST API. * Использование веб-пакета SDK Azure Maps позволяет настроить приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или версии 2.0 поддерживает рабочие, учебные заведения и гости, но не поддерживает личные учетные записи.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса службы языка.

Тип: apiKey
В: header

Примеры

Successful query

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

HTTP

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/sources?api-version=2023-04-15-preview

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

Код состояния:: 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

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

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

ErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

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

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

InnerErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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

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

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

QnaSources

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

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

sourceContentStructureKind

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

Имя	Тип	Описание
unstructured	string

sourceKind

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

Имя	Тип	Описание
file	string
url	string

Поделиться через