Question Answering Projects - List Deployments

Ссылка

Служба:: Cognitive Services - Language

Версия API:: 2023-04-01

Вывод списка всех развертываний проекта.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/deployments?api-version=2023-04-01

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	ProjectDeployments	Список развертываний проекта.
Other Status Codes	ErrorResponse	Ответ об ошибке.

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

AADToken

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

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, которые могут управлять доступом к определенным 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/deployments?api-version=2023-04-01

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

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

{
  "value": [
    {
      "deploymentName": "production",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    }
  ]
}

Определения

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

Error

Объект 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	Объект error.

InnerErrorCode