Cómo crear proyectos en el flujo de trabajo de orquestación

El flujo de trabajo de orquestación permite crear proyectos que conectan las aplicaciones a los servicios siguientes:

• Reconocimiento del lenguaje personalizado
• Respuesta a preguntas
• LUIS

Requisitos previos

Antes de empezar a utilizar el flujo de trabajo de orquestación, necesitará varias cosas:

• Una suscripción a Azure (cree una cuenta gratuita).
• Un recurso de Lenguaje Azure AI

Creación de un recurso de idioma

Antes de empezar a utilizar el flujo de trabajo de orquestación, necesitará un recurso de Lenguaje de Azure AI.

Nota:

• Para crear un recurso de idioma, debe tener asignado un rol de propietario en el grupo de recursos.
• Si planea usar la respuesta a preguntas, debe habilitar la respuesta a preguntas en la creación de recursos.

Creación de un nuevo recurso en Azure Portal

1. Vaya a Azure Portal y cree un recurso de Lenguaje de Azure AI.

2. Seleccione Continuar para crear el recurso.

3. Cree un recurso de idioma con los detalles siguientes.

   Detalles de la instancia	Valor obligatorio
   Region	Una de las regiones admitidas.
   Nombre	Nombre para el recurso lingüístico.
   Plan de tarifa	Uno de los planes de tarifa admitidos.

Creación de un nuevo recurso de idioma desde Language Studio

Si es la primera vez que inicia sesión, verá una ventana en Language Studio que le permitirá elegir un recurso de idioma existente o crear uno. También puede crear un recurso; para ello, haga clic en el icono de configuración de la esquina superior derecha, seleccione Recursos y, a continuación, haga clic en Crear un nuevo recurso.

Cree un recurso de idioma con los detalles siguientes.

Detalles de la instancia	Valor requerido
Suscripción de Azure	Su suscripción de Azure
Grupo de recursos de Azure	Su grupo de recursos de Azure
Nombre de recurso de Azure	Nombre de su recurso de Azure
Location	Obtenga más información sobre las regiones admitidas.
Plan de tarifa	Obtenga más información sobre los planes de tarifa admitidos.

Importante

• Asegúrese de habilitar la opción Identidad administrada al crear el recurso de idioma.
• Lea y confirme el aviso de inteligencia artificial responsable.

Inicio de sesión en Language Studio

Para crear una nueva intención, seleccione el botón +Agregar y, para empezar, asígnele un nombre. Verá dos opciones: conectarse a un proyecto o no. Puede conectarse a proyectos de LUIS, respuesta a preguntas o reconocimiento del lenguaje conversacional, o elegir la opción de no conectarse.

Creación de un proyecto de flujo de trabajo de orquestación

Una vez que haya creado un recurso de lenguaje, cree un proyecto de flujo de trabajo de orquestación.

Language Studio

1. En Language Studio, busque la sección Comprensión de preguntas y lenguaje conversacional y seleccione Flujo de trabajo de orquestación.

   

2. Esta acción lo llevará a la página proyecto de flujo de trabajo de orquestación. Seleccione Create new project (Crear proyecto). Para crear un proyecto, deberá proporcionar los detalles siguientes:

Value	Descripción
Nombre	Nombre del proyecto.
Descripción	Descripción opcional del proyecto.
Idioma principal de las expresiones	Idioma principal del proyecto. Los datos de entrenamiento deben estar principalmente en este idioma.

Cuando haya terminado, seleccione Siguiente y revise los detalles. Seleccione Crear proyecto para completar el proceso. Ahora debería ver la pantalla Compilación de esquema en el proyecto.

API de REST

Envíe una solicitud PATCH con la dirección URL, los encabezados y el cuerpo JSON que se incluyen a continuación para crear un nuevo proyecto.

URL de la solicitud

Use la siguiente dirección URL al crear la solicitud de API. Reemplace los valores de los marcadores de posición por sus propios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Marcador de posición	Valor	Ejemplo
{ENDPOINT}	Punto de conexión para autenticar la solicitud de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	myProject
{API-VERSION}	La versión de la API a la que llama.	2023-04-01

encabezados

Use el siguiente encabezado para autenticar la solicitud.

Clave	Valor
Ocp-Apim-Subscription-Key	Clave para el recurso. Se usa para autenticar las solicitudes de API.

Body

Use el siguiente código JSON de ejemplo como cuerpo.

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Orchestration",
  "description": "Project description"
 }

Clave	Marcador de posición	Valor	Ejemplo
projectName	{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	EmailApp
language	{LANGUAGE-CODE}	Una cadena que especifica el código de idioma de las expresiones que se usan en el proyecto. Si el proyecto es un proyecto multilingüe, elija el código de idioma de la mayoría de las expresiones.	en-us

Importar un proyecto de flujo de trabajo de orquestación

Language Studio

Puede exportar un proyecto de flujo de trabajo de orquestación como un archivo JSON en cualquier momento yendo a la página de proyectos de flujo de trabajo de orquestación, seleccionando un proyecto y, en el menú superior, haciendo clic en Exportar.

Ese proyecto se puede volver a importar como un proyecto nuevo. Si importa un proyecto con el mismo nombre exacto, reemplaza los datos del proyecto por los datos del proyecto recién importado.

Para importar un proyecto, seleccione el botón de flecha situado junto a Crear un proyecto y seleccione Importar, y después seleccione el archivo JSON.

API de REST

Puede importar un JSON de flujo de trabajo de orquestación en el servicio

Envíe una solicitud POST con la dirección URL, los encabezados y el cuerpo JSON que se incluyen a continuación para importar el proyecto.

URL de la solicitud

Use la siguiente dirección URL al crear la solicitud de API. Reemplace los valores de los marcadores de posición por sus propios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}

Marcador de posición	Valor	Ejemplo
{ENDPOINT}	Punto de conexión para autenticar la solicitud de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	myProject
{API-VERSION}	La versión de la API a la que llama.	2023-04-01

encabezados

Use el siguiente encabezado para autenticar la solicitud.

Clave	Valor
Ocp-Apim-Subscription-Key	Clave para el recurso. Se usa para autenticar las solicitudes de API.

Body

Nota:

Cada intención solo debe ser de un único tipo (a elegir entre CLU, LUIS y qna)

Use el siguiente código JSON de ejemplo como cuerpo.

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Orchestration",
    "settings": {
      "confidenceThreshold": 0
    },
    "projectName": "{PROJECT-NAME}",
    "description": "Project description",
    "language": "{LANGUAGE-CODE}"
  },
  "assets": {
    "projectKind": "Orchestration",
    "intents": [
      {
        "category": "string",
        "orchestration": {
          "kind": "luis",
          "luisOrchestration": {
            "appId": "00000000-0000-0000-0000-000000000000",
            "appVersion": "string",
            "slotName": "string"
          },
          "cluOrchestration": {
            "projectName": "string",
            "deploymentName": "string"
          },
          "qnaOrchestration": {
            "projectName": "string"
          }
        }
      }
    ],
    "utterances": [
      {
        "text": "Trying orchestration",
        "language": "{LANGUAGE-CODE}",
        "intent": "string"
      }
    ]
  }
}

Clave	Marcador de posición	Valor	Ejemplo
api-version	{API-VERSION}	Versión de la API a la que se llama. La versión que se use aquí debe ser la misma versión de API en la dirección URL.	2022-03-01-preview
projectName	{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	EmailApp
language	{LANGUAGE-CODE}	Una cadena que especifica el código de idioma de las expresiones que se usan en el proyecto. Si el proyecto es un proyecto multilingüe, elija el código de idioma de la mayoría de las expresiones.	en-us

Exportar un proyecto

Language Studio

Puede exportar un proyecto del flujo de trabajo de orquestación como un archivo JSON en cualquier momento; para ello, vaya a la página de proyectos del flujo de trabajo de orquestación y seleccione un proyecto y presione Exportar.

API de REST

Puede exportar un proyecto de flujo de trabajo de orquestación como un archivo JSON en cualquier momento.

Cree una solicitud POST con la dirección URL, los encabezados y el cuerpo JSON siguientes para exportar el proyecto.

URL de la solicitud

Use la siguiente dirección URL al crear la solicitud de API. Reemplace los valores de los marcadores de posición por sus propios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:export?stringIndexType=Utf16CodeUnit&api-version={API-VERSION}

Marcador de posición	Valor	Ejemplo
{ENDPOINT}	Punto de conexión para autenticar la solicitud de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	EmailApp
{API-VERSION}	La versión de la API a la que llama.	2023-04-01

encabezados

Use el siguiente encabezado para autenticar la solicitud.

Clave	Valor
Ocp-Apim-Subscription-Key	Clave para el recurso. Se usa para autenticar las solicitudes de API.

Una vez que envíe la solicitud de API, recibirá una respuesta 202 que indica que se ha realizado correctamente. En los encabezados de respuesta, extraiga el valor operation-location. Tendrá el formato siguiente:

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

JOB-ID se usa para identificar la solicitud, ya que esta operación es asincrónica. Use esta dirección URL para obtener el JSON del proyecto exportado mediante el mismo método de autenticación.

Obtener los detalles del proyecto de orquestación

Language Studio

1. Vaya a la página de configuración del proyecto en Language Studio.

2. Puede ver los detalles del proyecto.

3. En esta página puede actualizar la descripción del proyecto.

4. Igualmente, puede recuperar la clave de recurso principal en esta página.

   

API de REST

Para obtener los detalles de un proyecto de flujo de trabajo de orquestación, envíe una solicitud de OBTENER usando la dirección URL y encabezados. Reemplace los valores de los marcadores de posición por sus propios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Marcador de posición	Valor	Ejemplo
{ENDPOINT}	Punto de conexión para autenticar la solicitud de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	myProject
{API-VERSION}	La versión de la API a la que llama.	2023-04-01

encabezados

Use el siguiente encabezado para autenticar la solicitud.

Clave	Valor
Ocp-Apim-Subscription-Key	Clave para el recurso. Se usa para autenticar las solicitudes de API.

Cuerpo de la respuesta

Una vez que envíe la solicitud, recibirá la siguiente respuesta.

{
  "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": "Orchestration",
  "projectName": "{PROJECT-NAME}",
  "description": "This is a sample orchestration project.",
  "language": "{LANGUAGE-CODE}"
}

Una vez que envíe la solicitud de API, recibirá una respuesta 200 que indica que se ha realizado correctamente y el cuerpo de la respuesta JSON con los detalles del proyecto.

Eliminar proyecto

Language Studio

Cuando ya no necesite el proyecto, puede eliminarlo mediante Language Studio. Seleccione Projectos del menú de navegación izquierdo, seleccione el proyecto que quiera eliminar y, a continuación, seleccione Eliminar en el menú superior.

API de REST

Cuando ya no necesite el proyecto, puede eliminarlo mediante las API.

Cree una solicitud deELIMINAR con la dirección URL, los encabezados y el cuerpo JSON que se incluyen a continuación para eliminar un proyecto de reconocimiento del lenguaje conversacional.

URL de la solicitud

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Marcador de posición	Valor	Ejemplo
{ENDPOINT}	Punto de conexión para autenticar la solicitud de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	Nombre del proyecto. Este valor distingue mayúsculas de minúsculas.	myProject
{API-VERSION}	La versión de la API a la que llama.	2023-04-01

encabezados

Use el siguiente encabezado para autenticar la solicitud.

Clave	Valor
Ocp-Apim-Subscription-Key	Clave para el recurso. Se usa para autenticar las solicitudes de API.

Una vez que envíe la solicitud de API, recibirá una respuesta 202 que indica que se ha realizado correctamente, lo que significa que el proyecto se ha eliminado.

Pasos siguientes

Compilación de esquema