Conversational Analysis Authoring - Get Project

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-01

Obtém os detalhes de um projeto.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string
projectName	path	True	string	O novo nome do projeto.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Successful Get Project

Solicitação de exemplo

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2023-04-01

Resposta de exemplo

Código de status:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definições

Nome	Description
ConversationalAnalysisAuthoringProjectMetadata	Representa os metadados de um projeto.
ConversationalAnalysisAuthoringProjectSettings	Representa as configurações usadas para definir o comportamento do projeto.
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 API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind

ConversationalAnalysisAuthoringProjectMetadata

Representa os metadados de um projeto.

Nome	Tipo	Description
createdDateTime	string	Representa o datetime de criação do projeto.
description	string	A descrição do projeto.
language	string	A linguagem do projeto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
lastDeployedDateTime	string	Representa o datetime do projeto implantado pela última vez.
lastModifiedDateTime	string	Representa o datetime de criação do projeto.
lastTrainedDateTime	string	Representa o último datetime treinado do projeto.
multilingual	boolean	Se o projeto seria usado para vários idiomas ou não.
projectKind	ProjectKind	Representa o tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ConversationalAnalysisAuthoringProjectSettings	As configurações do projeto.

ConversationalAnalysisAuthoringProjectSettings

Representa as configurações usadas para definir o comportamento do projeto.

Nome	Tipo	Description
confidenceThreshold	number	O limite da intenção com a maior confiança, na qual a previsão será automaticamente alterada para "Nenhum". O valor do limite deve estar entre 0 e 1, inclusive.

Error

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
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 pelo ser humano do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	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.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode