Question Answering Projects - List Deployments

Služba:

Azure AI Services

Verze rozhraní API:

2021-10-01

Zobrazí seznam všech nasazení projektu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Název projektu, který se má použít.
api-version	query	True	string	Verze rozhraní API klienta.
maxpagesize	query		integer (int32)	Maximální počet prostředků, které se mají zahrnout do jedné odpovědi.
skip	query		integer (int32)	Posun do kolekce prvního prostředku, který se má vrátit.
top	query		integer (int32)	Maximální počet prostředků, které se mají vrátit z kolekce.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	ProjectDeployments	Seznam nasazení projektu
Other Status Codes	ErrorResponse	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Successful query

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectDeployment	Podrobnosti o nasazení projektu
ProjectDeployments	Všechna nasazení projektu.

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Zpráva o chybě.
target	string	Cíl chyby

ProjectDeployment

Objekt

Podrobnosti o nasazení projektu

Name	Typ	Description
deploymentName	string	Název nasazení
lastDeployedDateTime	string (date-time)	Představuje datum a čas posledního nasazení projektu.

ProjectDeployments

Objekt

Všechna nasazení projektu.

Name	Typ	Description
nextLink	string
value	ProjectDeployment[]	Seznam nasazení projektu