Conversational Analysis Authoring - Get Project

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2023-04-01

Obtiene los detalles de un proyecto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string
projectName	path	True	string	Nombre del nuevo proyecto.
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Successful Get Project

Solicitud de ejemplo

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2023-04-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

ConversationalAnalysisAuthoringProjectMetadata

Representa los metadatos de un proyecto.

Nombre	Tipo	Description
createdDateTime	string	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	Representa la fecha y hora de la última implementación del proyecto.
lastModifiedDateTime	string	Representa la fecha y hora de creación del proyecto.
lastTrainedDateTime	string	Representa el último proyecto entrenado datetime.
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

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

Nombre	Tipo	Description
confidenceThreshold	number	Umbral de la intención con la mayor confianza, en la que la predicción se cambiará automáticamente a "None". El valor del umbral debe estar comprendido entre 0 y 1 inclusive.

Error

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

Código de error legible para personas.

Nombre	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

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode