Text Analysis Authoring - List Deployments

Referência

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Listas as implementações pertencentes a um projeto.

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

With optional parameters:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.
maxpagesize	query		integer int32	O número máximo de recursos a incluir numa única resposta.
skip	query		integer int32	Um desvio para a coleção do primeiro recurso a ser devolvido.
top	query		integer int32	O número máximo de recursos a devolver da coleção.

Respostas

Name	Tipo	Description
200 OK	TextAnalysisAuthoringProjectDeployments	Lista de todas as implementações.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Type: apiKey
In: header

Exemplos

Successful List Deployments

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "deploymentName": "production",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
      "lastDeployedDateTime": "2022-04-18T16:03:51Z",
      "deploymentExpirationDate": "2023-10-28",
      "modelTrainingConfigVersion": "2022-05-01"
    },
    {
      "deploymentName": "staging",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
      "lastDeployedDateTime": "2022-04-18T15:53:04Z",
      "deploymentExpirationDate": "2023-10-28",
      "modelTrainingConfigVersion": "2022-05-01"
    }
  ],
  "nextLink": null
}

Definições

Name	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringProjectDeployment	Representa uma implementação de projeto.
TextAnalysisAuthoringProjectDeployments	Representa uma lista de implementações obtidas.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Name	Tipo	Description
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

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode