Question Answering Projects - List Deployments

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

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

Параметры URI

Name In Required Type Description
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

Максимальное количество ресурсов, возвращаемых из коллекции.

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

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Ответы

Name Type Description
200 OK

Список развертываний проекта.

Other Status Codes

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

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Successful query

Sample Request

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

Sample Response

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

Определения

Error

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

ErrorCode

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

ErrorResponse

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

InnerErrorCode

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

InnerErrorModel

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

ProjectDeployment

Project сведения о развертывании.

ProjectDeployments

Все развертывания проекта.

Error

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

Name Type Description
code

Один из определяемых сервером кодов ошибок.

details

Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.

innererror

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

message
  • string

Удобочитаемое представление ошибки.

target
  • string

Целевой объект ошибки.

ErrorCode

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

Name Type Description
AzureCognitiveSearchIndexLimitReached
  • string
AzureCognitiveSearchIndexNotFound
  • string
AzureCognitiveSearchNotFound
  • string
AzureCognitiveSearchThrottling
  • string
Forbidden
  • string
InternalServerError
  • string
InvalidArgument
  • string
InvalidRequest
  • string
NotFound
  • string
OperationNotFound
  • string
ProjectNotFound
  • string
ServiceUnavailable
  • string
TooManyRequests
  • string
Unauthorized
  • string

ErrorResponse

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

Name Type Description
error

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

InnerErrorCode

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

Name Type Description
AzureCognitiveSearchNotFound
  • string
AzureCognitiveSearchThrottling
  • string
ExtractionFailure
  • string
InvalidParameterValue
  • string
InvalidRequest
  • string
KnowledgeBaseNotFound
  • string

InnerErrorModel

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

Name Type Description
code

Один из определяемых сервером кодов ошибок.

details
  • object

Сведения об ошибке.

innererror

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.

message
  • string

Сообщение об ошибке.

target
  • string

Целевой объект ошибки.

ProjectDeployment

Project сведения о развертывании.

Name Type Description
deploymentName
  • string

Имя развертывания.

lastDeployedDateTime
  • string

Представляет дату и время последнего развертывания проекта.

ProjectDeployments

Все развертывания проекта.

Name Type Description
nextLink
  • string
value

Список развертываний проекта.