Conversational Analysis Authoring - Get Project

Servicio:

Azure AI Services

Versión de la API:

2022-05-01

Obtiene los detalles de un proyecto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services admitido (por ejemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Una clave de suscripción para un recurso de servicio de lenguaje.

Respuestas

Nombre	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Los metadatos del proyecto.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful Get Project

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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"
}

Definiciones

Nombre	Description
ConversationalAnalysisAuthoringProjectMetadata	Representa los metadatos de un proyecto.
ConversationalAnalysisAuthoringProjectSettings	Representa la configuración utilizada para definir el comportamiento del proyecto.
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Representa el tipo de proyecto.

ConversationalAnalysisAuthoringProjectMetadata

Object

Representa los metadatos de un proyecto.

Nombre	Tipo	Description
createdDateTime	string (date-time)	Representa la fecha y hora de creación del proyecto.
description	string	Descripción del proyecto.
language	string	Lenguaje del proyecto. Esta es la representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés, "en-gb" para inglés (Reino Unido), "es" para español, etc.
lastDeployedDateTime	string (date-time)	Representa la fecha y hora implementada por última vez en el proyecto.
lastModifiedDateTime	string (date-time)	Representa la fecha y hora de creación del proyecto.
lastTrainedDateTime	string (date-time)	Representa la fecha y hora del último entrenamiento del proyecto.
multilingual	boolean	Si el proyecto se usaría para varios lenguajes o no.
projectKind	ProjectKind	Representa el tipo de proyecto.
projectName	string	Nombre del nuevo proyecto.
settings	ConversationalAnalysisAuthoringProjectSettings	Configuración del proyecto.

ConversationalAnalysisAuthoringProjectSettings

Object

Representa la configuración utilizada para definir el comportamiento del proyecto.

Nombre	Tipo	Description
confidenceThreshold	number (float)	El umbral de la intención con la mayor confianza, en el que la predicción se cambiará automáticamente a "Ninguna".

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

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

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

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

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

ProjectKind

Enumeración

Representa el tipo de proyecto.

Valor	Description
Conversation	Un proyecto para crear lenguaje natural en aplicaciones, bots y dispositivos IoT.
Orchestration	Un proyecto para conectar y orquestar proyectos de conversación, respuesta a preguntas personalizadas y LUIS en un solo proyecto.