Conversational Analysis Authoring - Get Project

Serviço:

Azure AI Services

Versão da API:

2022-05-01

Obtém os detalhes de um projeto.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de assinatura para um recurso de serviço de idioma.

Respostas

Name	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Os metadados do projeto.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de idioma.

Tipo: apiKey
Em: header

Exemplos

Successful Get Project

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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

Name	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	Representa o tipo de projeto.

ConversationalAnalysisAuthoringProjectMetadata

Object

Representa os metadados de um projeto.

Name	Tipo	Description
createdDateTime	string (date-time)	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 uma língua. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
lastDeployedDateTime	string (date-time)	Representa o último projeto implantado datetime.
lastModifiedDateTime	string (date-time)	Representa o datetime de criação do projeto.
lastTrainedDateTime	string (date-time)	Representa a última data/hora treinada 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

Object

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

Name	Tipo	Description
confidenceThreshold	number (float)	O limiar da intenção com a maior confiança, no qual a previsão será automaticamente alterada para "Nenhuma".

Error

Object

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Object

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.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.

ProjectKind

Enumeração

Representa o tipo de projeto.

Valor	Description
Conversation	Um projeto para criar linguagem natural em aplicativos, bots e dispositivos IoT.
Orchestration	Um projeto para conectar e orquestrar conversação, resposta a perguntas personalizadas e projetos LUIS juntos em um único projeto.