Conversational Analysis Authoring - Create Project

Referencia

Servicio:: Cognitive Services - Language

Versión de la API:: 2022-05-01

Crea un nuevo proyecto o actualiza uno existente.

PATCH {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 compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de API del cliente.

Encabezado de la solicitud

Media Types: "application/merge-patch+json"

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

Cuerpo de la solicitud

Media Types: "application/merge-patch+json"

Nombre	Requerido	Tipo	Description
language	True	string	Lenguaje del proyecto. Esta es una 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.
projectKind	True	ProjectKind	Representa el tipo de proyecto.
projectName	True	string	Nombre del nuevo proyecto.
description		string	Descripción del proyecto.
multilingual		boolean	Si el proyecto se usaría para varios lenguajes o no.
settings		ConversationalAnalysisAuthoringProjectSettings	Configuración del proyecto.

Respuestas

Nombre	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Metadatos del proyecto actualizado, si ya existe.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	Metadatos del proyecto creado.
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 Create Project

Solicitud de ejemplo

HTTP

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


{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

Respuesta de muestra

status code:: 201

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

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
ConversationalAnalysisAuthoringCreateProjectOptions	Representa las opciones usadas para crear o actualizar un proyecto.
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.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible.
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.

ConversationalAnalysisAuthoringCreateProjectOptions

Representa las opciones usadas para crear o actualizar un proyecto.

Nombre	Tipo	Description
description	string	Descripción del proyecto.
language	string	Lenguaje del proyecto. Esta es una 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.
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.

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 una 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 el proyecto la última fecha y hora implementada.
lastModifiedDateTime	string	Representa la fecha y hora de creación del proyecto.
lastTrainedDateTime	string	Representa el proyecto la última fecha y hora entrenada.
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".

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.

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