Migra de Dialogflow ES a CX

Los agentes de Dialogflow CX te proporcionan controles y herramientas de conversación más potentes que los agentes de Dialogflow ES. Si tu agente de Dialogflow ES controla conversaciones complejas, debes considerar migrar a Dialogflow CX.

En esta guía, se describe cómo migrar un agente de Dialogflow ES a Dialogflow CX. Estos dos tipos de agentes tienen muchas diferencias fundamentales, por lo que no hay una forma directa de realizar esta migración.

Si usas esta guía para una migración, haz clic en el botón Enviar comentarios que aparece arriba a fin de proporcionar comentarios positivos o negativos. Usaremos estos comentarios para mejorar esta guía con el tiempo.

En general, el proceso recomendado es un proceso híbrido automatizado/manual. Usarás una herramienta que lea algunos de tus datos del agente de Dialogflow ES, los escriba en tu agente de Dialogflow CX y capture una lista de tareas pendientes. Luego, vuelve a crear tu agente de CX completo con las prácticas recomendadas, la lista de tareas pendientes y los datos que migró la herramienta.

Comprende Dialogflow CX

Antes de intentar esta migración, debes tener una comprensión sólida de cómo funciona Dialogflow CX. Puedes comenzar aquí:

  1. Aspectos básicos
  2. Videos introductorios
  3. Guías de inicio rápido

También debes leer documentos de conceptos adicionales que tienen características que es probable que necesites en tu agente nuevo. Enfócate en lo siguiente:

Comprenda las diferencias entre ES y CX

En esta sección, se enumeran las diferencias más importantes entre Dialogflow ES y CX. Cuando realices pasos de migración manual más adelante, debes consultar esta sección para obtener orientación.

Control de la estructura y la ruta de conversación

ES proporciona lo siguiente para el control de la estructura y la ruta de conversación:

  • Los intents se usan como los componentes básicos del agente. En cualquier momento de la conversación, se detecta una coincidencia con un intent y, en cierto sentido, cada intent es un nodo para la conversación.
  • El contexto se usa para controlar la conversación. El contexto se usa para controlar qué intents coinciden en cualquier momento. El contexto expira después de una cierta cantidad de turnos de conversación, por lo que este tipo de control puede ser inexacto para conversaciones largas.

CX proporciona una jerarquía de recursos de estructura y controles más precisos sobre la ruta de conversación:

  • Las páginas son nodos del gráfico para la conversación. Las conversaciones de CX son similares a las máquinas de estado. Hay una página activa en todo momento de la conversación. Según las entradas o los eventos del usuario final, la conversación puede pasar a otra página. Es común que una página permanezca activa durante varios turnos de conversación.
  • Los flujos son grupos de páginas relacionadas. Cada flujo debe manejar un tema de conversación de alto nivel.
  • Los controladores de estado se usan para controlar las transiciones y las respuestas. Existen tres tipos de controladores de estado:
    • Ruta de intent: Contiene un intent que debe coincidir, respuestas opcionales y una transición de página opcional.
    • Ruta de condición: Contiene una condición que se debe cumplir, respuestas opcionales y una transición de página opcional.
    • Controlador de eventos: Contiene un nombre de evento que se debe invocar, respuestas opcionales y una transición de página opcional.
  • Scope se usa para controlar si se puede llamar a un controlador de estado. La mayoría de los controladores están asociados con una página o con todo el flujo. Si la página o el flujo asociados están activos, el controlador está dentro del alcance y se lo puede llamar. Una ruta de intents de CX dentro del alcance es similar a un intent de ES con un contexto de entrada que está activo.

Cuando diseñes los flujos y las páginas de tu agente, asegúrate de comprender los consejos de la sección de flujo de la guía de diseño del agente.

Relleno de formularios

ES usa el relleno de ranuras para recopilar los parámetros obligatorios del usuario final:

  • Estos parámetros son parámetros de intent marcados como obligatorios.
  • Se seguirá buscando la coincidencia con el intent hasta que se recopilen todos los parámetros obligatorios.
  • Puedes definir un mensaje para solicitarle al usuario final que proporcione un valor.

CX usa el completado de formularios para recopilar los parámetros obligatorios del usuario final:

  • Estos parámetros se asocian con una página y se recopilan mientras la página está activa.
  • Usa las rutas de condición para las páginas a fin de determinar si se completó el formulario. Por lo general, estas rutas de condición pasan a otra página.
  • Puedes definir un mensaje y controladores de nuevo mensaje para manejar de forma correcta varios intentos de recopilar un valor.

Transiciones

ES pasa automáticamente de un intent al siguiente cuando la entrada del usuario final coincide con un intent. Esta coincidencia solo puede ocurrir para los intents que no tienen contexto de entrada o para intents que tengan un contexto de entrada activo.

CX pasa de una página a la siguiente cuando un controlador de estado dentro del alcance cumple con sus requisitos y proporciona un destino de transición. Con estas transiciones, puedes guiar a los usuarios finales de manera confiable a través de las conversaciones. Existen varias formas de controlar estas transiciones:

  • La coincidencia de intents puede activar una ruta de intents.
  • Satisfacer una condición puede activar una ruta de condición.
  • La invocación de un evento puede activar un controlador de eventos.
  • Los controladores de solicitudes nuevas pueden provocar una transición cuando el usuario final no puede proporcionar un valor después de varios intentos.
  • Puedes usar objetivos de transición simbólicos para estos.

Respuestas del agente

Las respuestas del agente de ES se envían al usuario final cuando se detecta una coincidencia con un intent:

  • El agente puede seleccionar un mensaje para la respuesta de una lista de respuestas posibles.
  • Las respuestas pueden ser específicas de la plataforma y usar formatos de respuesta enriquecida.
  • Los webhooks pueden impulsar las respuestas.

Las respuestas del agente de CX se envían al usuario final cuando se llama a la entrega. A diferencia de la entrega de ES, que siempre involucra un webhook, la entrega de CX puede o no implicar la llamada a un webhook, en función de si el recurso de entrega tiene uno configurado. La entrega controla las respuestas estáticas y dinámicas basadas en respuestas de webhook. Existen varias formas de crear respuestas del agente:

  • La entrega se puede proporcionar a cualquier tipo de controlador de estado.
  • Se pueden concatenar varias respuestas durante un turno de conversación a través de la cola de respuestas. Esta característica puede simplificar el diseño de tu agente en algunos casos.
  • CX no es compatible con las respuestas específicas de la plataforma incorporadas. Sin embargo, proporciona varios tipos de respuesta, incluida una carga útil personalizada que se puede usar para respuestas específicas de la plataforma.

Parámetros

Los parámetros ES tienen las siguientes características:

  • Se define solo en intents.
  • Se establece mediante entradas del usuario final, eventos, webhooks y llamadas a la API.
  • Se hace referencia en las respuestas, los mensajes de parámetros, el código de webhook y los valores de parámetros:
    • El formato de referencia básico es $parameter-name.
    • Las referencias admiten la sintaxis de los sufijos .original, .partial y .recent.
    • Las referencias pueden especificar el contexto activo: #context-name.parameter-name.
    • Las referencias pueden especificar parámetros de eventos: #event-name.parameter-name.

Los parámetros de CX tienen las siguientes características:

  • Se define en intents y formularios de página.
  • Los parámetros de intent y de formulario se propagan a parámetros de sesión, donde están disponibles para su referencia mientras dure la sesión.
  • Se establece mediante la entrada del usuario final, webhooks, ajustes predeterminados de parámetros de entrega y llamadas a la API.
  • Se hace referencia en respuestas, mensajes de parámetros, controladores de solicitudes nuevas, ajustes predeterminados de parámetros y código de webhook:
    • El formato de referencia es $session.params.parameter-id para los parámetros de sesión y $intent.params.parameter-id para los parámetros de intents.
    • Las referencias del parámetro de intent admiten la sintaxis del sufijo .original y .resolved. Los parámetros de sesión no admiten esta sintaxis.

Entidades del sistema

ES admite muchas entidades del sistema.

CX admite muchas de las mismas entidades del sistema, pero hay algunas diferencias. Durante la migración, verifica que las entidades del sistema que usas en ES también sean compatibles con CX para el mismo idioma. De lo contrario, debes crear entidades personalizadas para estas.

Eventos

Los eventos de ES tienen las siguientes características:

  • Se puede invocar desde llamadas a la API o webhooks para que coincidan con un intent.
  • Puede establecer parámetros.
  • Las plataformas de integración invocan una pequeña cantidad de eventos.

Los eventos de CX tienen las siguientes características:

  • Se puede invocar desde llamadas a la API o webhooks para llamar a un controlador de eventos.
  • No se pueden establecer los parámetros.
  • Muchos eventos integrados se pueden usar para controlar la falta de entradas del usuario final, las entradas del usuario final no reconocidas, los parámetros invalidados por un webhook y los errores de webhook.
  • Las invocaciones se pueden controlar con las mismas reglas de alcance que otros controladores de estado.

Intents integrados

ES admite los siguientes intents integrados:

A continuación, se describe la compatibilidad de CX con los intents integrados:

  • Se admiten los intents de bienvenida.
  • No se proporcionan intents de resguardo. En su lugar, usa los eventos no-match en los controladores de eventos.
  • En el caso de ejemplos negativos, usa el intent negativo predeterminado.
  • No se proporcionan los intents de seguimiento predefinidos. Debes crear estos intents según lo requiera tu agente. Por ejemplo, es probable que necesites crear un intent para manejar respuestas negativas a la pregunta de un agente ("no", "no, gracias", "no, no lo hago", etcétera). Los intents de CX se pueden reutilizar en todo tu agente, por lo que solo debes definirlos una vez. El uso de rutas de intents diferentes para estos intents comunes en diferentes alcances te brinda un control mucho mejor sobre la conversación.

Webhooks

Los webhooks de ES tienen las siguientes características:

  • Puedes configurar un servicio de webhook para el agente.
  • Se puede marcar cada intent para que use el webhook.
  • No hay compatibilidad integrada para manejar errores de webhook.
  • Los webhooks usan las acciones de intent o los nombres de intents para determinar desde qué parte del agente se llamó.
  • La consola proporciona el editor directo.

Los webhooks de CX tienen las siguientes características:

  • Puedes configurar varios servicios de webhook para el agente.
  • De manera opcional, cada entrega puede especificar una llamada de webhook.
  • El manejo de errores de webhook tiene compatibilidad integrada.
  • Un webhook de entrega de CX contiene una etiqueta. Esta etiqueta es similar a una acción de ES, pero solo se usa cuando se llama a webhooks. El servicio de webhook puede usar estas etiquetas para determinar desde qué parte del agente se llamó.
  • La consola no tiene un editor de código de webhook integrado. El uso de Cloud Functions es frecuente, pero hay muchas opciones.

Cuando migres a CX, deberás cambiar el código de webhook, ya que las propiedades de solicitud y respuesta son diferentes.

Integraciones

Las integraciones de ES y las integraciones de CX admiten diferentes plataformas. En las plataformas compatibles con ambos tipos de agentes, puede haber diferencias en la configuración.

Si la integración de ES que usabas no es compatible con CX, es posible que debas cambiar de plataforma o implementar la integración por tu cuenta.

Más funciones exclusivas para CX

Hay muchas otras funciones que solo proporciona CX. Considera usar estas funciones durante la migración. Por ejemplo:

prácticas recomendadas

Antes de migrar, familiarízate con las prácticas recomendadas de diseño del agente de CX. Muchas de estas prácticas recomendadas de CX son similares a las de ES, pero algunas son exclusivas de CX.

Acerca de la herramienta de migración

La herramienta de migración copia la mayor parte de los datos de ES en tu agente de CX, y escribe en un archivo TODO con una lista de elementos que deben migrarse de forma manual. La herramienta solo copia tipos de entidades personalizadas y frases de entrenamiento de intents. Deberías personalizar esta herramienta según tus necesidades específicas.

Código de la herramienta de migración

Este es el código de la herramienta. Debes revisar el código de esta herramienta, para comprender lo que hace. Es posible que desees cambiar este código para controlar situaciones específicas en tu agente. En los siguientes pasos, ejecutarás esta herramienta.

// Package main implements the ES to CX migration tool.
package main

import (
	"context"
	"encoding/csv"
	"flag"
	"fmt"
	"os"
	"strings"
	"time"

	v2 "cloud.google.com/go/dialogflow/apiv2"
	proto2 "cloud.google.com/go/dialogflow/apiv2/dialogflowpb"
	v3 "cloud.google.com/go/dialogflow/cx/apiv3"
	proto3 "cloud.google.com/go/dialogflow/cx/apiv3/cxpb"
	"google.golang.org/api/iterator"
	"google.golang.org/api/option"
)

// Commandline flags
var v2Project *string = flag.String("es-project-id", "", "ES project")
var v3Project *string = flag.String("cx-project-id", "", "CX project")
var v2Region *string = flag.String("es-region-id", "", "ES region")
var v3Region *string = flag.String("cx-region-id", "", "CX region")
var v3Agent *string = flag.String("cx-agent-id", "", "CX region")
var outFile *string = flag.String("out-file", "", "Output file for CSV TODO items")
var dryRun *bool = flag.Bool("dry-run", false, "Set true to skip CX agent writes")

// Map from entity type display name to fully qualified name.
var entityTypeShortToLong = map[string]string{}

// Map from ES system entity to CX system entity
var convertSystemEntity = map[string]string{
	"sys.address":         "sys.address",
	"sys.any":             "sys.any",
	"sys.cardinal":        "sys.cardinal",
	"sys.color":           "sys.color",
	"sys.currency-name":   "sys.currency-name",
	"sys.date":            "sys.date",
	"sys.date-period":     "sys.date-period",
	"sys.date-time":       "sys.date-time",
	"sys.duration":        "sys.duration",
	"sys.email":           "sys.email",
	"sys.flight-number":   "sys.flight-number",
	"sys.geo-city-gb":     "sys.geo-city",
	"sys.geo-city-us":     "sys.geo-city",
	"sys.geo-city":        "sys.geo-city",
	"sys.geo-country":     "sys.geo-country",
	"sys.geo-state":       "sys.geo-state",
	"sys.geo-state-us":    "sys.geo-state",
	"sys.geo-state-gb":    "sys.geo-state",
	"sys.given-name":      "sys.given-name",
	"sys.language":        "sys.language",
	"sys.last-name":       "sys.last-name",
	"sys.street-address":  "sys.location",
	"sys.location":        "sys.location",
	"sys.number":          "sys.number",
	"sys.number-integer":  "sys.number-integer",
	"sys.number-sequence": "sys.number-sequence",
	"sys.ordinal":         "sys.ordinal",
	"sys.percentage":      "sys.percentage",
	"sys.person":          "sys.person",
	"sys.phone-number":    "sys.phone-number",
	"sys.temperature":     "sys.temperature",
	"sys.time":            "sys.time",
	"sys.time-period":     "sys.time-period",
	"sys.unit-currency":   "sys.unit-currency",
	"sys.url":             "sys.url",
	"sys.zip-code":        "sys.zip-code",
}

// Issues found for the CSV output
var issues = [][]string{
	{"Field", "Issue"},
}

// logIssue logs an issue for the CSV output
func logIssue(field string, issue string) {
	issues = append(issues, []string{field, issue})
}

// convertEntityType converts an ES entity type to CX
func convertEntityType(et2 *proto2.EntityType) *proto3.EntityType {
	var kind3 proto3.EntityType_Kind
	switch kind2 := et2.Kind; kind2 {
	case proto2.EntityType_KIND_MAP:
		kind3 = proto3.EntityType_KIND_MAP
	case proto2.EntityType_KIND_LIST:
		kind3 = proto3.EntityType_KIND_LIST
	case proto2.EntityType_KIND_REGEXP:
		kind3 = proto3.EntityType_KIND_REGEXP
	default:
		kind3 = proto3.EntityType_KIND_UNSPECIFIED
	}
	var expansion3 proto3.EntityType_AutoExpansionMode
	switch expansion2 := et2.AutoExpansionMode; expansion2 {
	case proto2.EntityType_AUTO_EXPANSION_MODE_DEFAULT:
		expansion3 = proto3.EntityType_AUTO_EXPANSION_MODE_DEFAULT
	default:
		expansion3 = proto3.EntityType_AUTO_EXPANSION_MODE_UNSPECIFIED
	}
	et3 := &proto3.EntityType{
		DisplayName:           et2.DisplayName,
		Kind:                  kind3,
		AutoExpansionMode:     expansion3,
		EnableFuzzyExtraction: et2.EnableFuzzyExtraction,
	}
	for _, e2 := range et2.Entities {
		et3.Entities = append(et3.Entities, &proto3.EntityType_Entity{
			Value:    e2.Value,
			Synonyms: e2.Synonyms,
		})
	}
	return et3
}

// convertParameterEntityType converts a entity type found in parameters
func convertParameterEntityType(intent string, parameter string, t2 string) string {
	if len(t2) == 0 {
		return ""
	}
	t2 = t2[1:] // remove @
	if strings.HasPrefix(t2, "sys.") {
		if val, ok := convertSystemEntity[t2]; ok {
			t2 = val
		} else {
			t2 = "sys.any"
			logIssue("Intent<"+intent+">.Parameter<"+parameter+">",
				"This intent parameter uses a system entity not supported by CX English agents. See the migration guide for advice. System entity: "+t2)
		}
		return fmt.Sprintf("projects/-/locations/-/agents/-/entityTypes/%s", t2)
	}
	return entityTypeShortToLong[t2]
}

// convertIntent converts an ES intent to CX
func convertIntent(intent2 *proto2.Intent) *proto3.Intent {
	if intent2.DisplayName == "Default Fallback Intent" ||
		intent2.DisplayName == "Default Welcome Intent" {
		return nil
	}

	intent3 := &proto3.Intent{
		DisplayName: intent2.DisplayName,
	}

	// WebhookState
	if intent2.WebhookState != proto2.Intent_WEBHOOK_STATE_UNSPECIFIED {
		logIssue("Intent<"+intent2.DisplayName+">.WebhookState",
			"This intent has webhook enabled. You must configure this in your CX agent.")
	}

	// IsFallback
	if intent2.IsFallback {
		logIssue("Intent<"+intent2.DisplayName+">.IsFallback",
			"This intent is a fallback intent. CX does not support this. Use no-match events instead.")
	}

	// MlDisabled
	if intent2.MlDisabled {
		logIssue("Intent<"+intent2.DisplayName+">.MlDisabled",
			"This intent has ML disabled. CX does not support this.")
	}

	// LiveAgentHandoff
	if intent2.LiveAgentHandoff {
		logIssue("Intent<"+intent2.DisplayName+">.LiveAgentHandoff",
			"This intent uses live agent handoff. You must configure this in a fulfillment.")
	}

	// EndInteraction
	if intent2.EndInteraction {
		logIssue("Intent<"+intent2.DisplayName+">.EndInteraction",
			"This intent uses end interaction. CX does not support this.")
	}

	// InputContextNames
	if len(intent2.InputContextNames) > 0 {
		logIssue("Intent<"+intent2.DisplayName+">.InputContextNames",
			"This intent uses context. See the migration guide for alternatives.")
	}

	// Events
	if len(intent2.Events) > 0 {
		logIssue("Intent<"+intent2.DisplayName+">.Events",
			"This intent uses events. Use event handlers instead.")
	}

	// TrainingPhrases
	var trainingPhrases3 []*proto3.Intent_TrainingPhrase
	for _, tp2 := range intent2.TrainingPhrases {
		if tp2.Type == proto2.Intent_TrainingPhrase_TEMPLATE {
			logIssue("Intent<"+intent2.DisplayName+">.TrainingPhrases",
				"This intent has a training phrase that uses a template (@...) training phrase type. CX does not support this.")
		}
		var parts3 []*proto3.Intent_TrainingPhrase_Part
		for _, part2 := range tp2.Parts {
			parts3 = append(parts3, &proto3.Intent_TrainingPhrase_Part{
				Text:        part2.Text,
				ParameterId: part2.Alias,
			})
		}
		trainingPhrases3 = append(trainingPhrases3, &proto3.Intent_TrainingPhrase{
			Parts:       parts3,
			RepeatCount: 1,
		})
	}
	intent3.TrainingPhrases = trainingPhrases3

	// Action
	if len(intent2.Action) > 0 {
		logIssue("Intent<"+intent2.DisplayName+">.Action",
			"This intent sets the action field. Use a fulfillment webhook tag instead.")
	}

	// OutputContexts
	if len(intent2.OutputContexts) > 0 {
		logIssue("Intent<"+intent2.DisplayName+">.OutputContexts",
			"This intent uses context. See the migration guide for alternatives.")
	}

	// ResetContexts
	if intent2.ResetContexts {
		logIssue("Intent<"+intent2.DisplayName+">.ResetContexts",
			"This intent uses context. See the migration guide for alternatives.")
	}

	// Parameters
	var parameters3 []*proto3.Intent_Parameter
	for _, p2 := range intent2.Parameters {
		if len(p2.Value) > 0 && p2.Value != "$"+p2.DisplayName {
			logIssue("Intent<"+intent2.DisplayName+">.Parameters<"+p2.DisplayName+">.Value",
				"This field is not set to $parameter-name. This feature is not supported by CX. See: https://cloud.google.com/dialogflow/es/docs/intents-actions-parameters#valfield.")
		}
		if len(p2.DefaultValue) > 0 {
			logIssue("Intent<"+intent2.DisplayName+">.Parameters<"+p2.DisplayName+">.DefaultValue",
				"This intent parameter is using a default value. CX intent parameters do not support default values, but CX page form parameters do. This parameter should probably become a form parameter.")
		}
		if p2.Mandatory {
			logIssue("Intent<"+intent2.DisplayName+">.Parameters<"+p2.DisplayName+">.Mandatory",
				"This intent parameter is marked as mandatory. CX intent parameters do not support mandatory parameters, but CX page form parameters do. This parameter should probably become a form parameter.")
		}
		for _, prompt := range p2.Prompts {
			logIssue("Intent<"+intent2.DisplayName+">.Parameters<"+p2.DisplayName+">.Prompts",
				"This intent parameter has a prompt. Use page form parameter prompts instead. Prompt: "+prompt)
		}
		if len(p2.EntityTypeDisplayName) == 0 {
			p2.EntityTypeDisplayName = "@sys.any"
			logIssue("Intent<"+intent2.DisplayName+">.Parameters<"+p2.DisplayName+">.EntityTypeDisplayName",
				"This intent parameter does not have an entity type. CX requires an entity type for all parameters..")
		}
		parameters3 = append(parameters3, &proto3.Intent_Parameter{
			Id:         p2.DisplayName,
			EntityType: convertParameterEntityType(intent2.DisplayName, p2.DisplayName, p2.EntityTypeDisplayName),
			IsList:     p2.IsList,
		})
		//fmt.Printf("Converted parameter: %+v\n", parameters3[len(parameters3)-1])
	}
	intent3.Parameters = parameters3

	// Messages
	for _, message := range intent2.Messages {
		m, ok := message.Message.(*proto2.Intent_Message_Text_)
		if ok {
			for _, t := range m.Text.Text {
				warnings := ""
				if strings.Contains(t, "#") {
					warnings += " This message may contain a context parameter reference, but CX does not support this."
				}
				if strings.Contains(t, ".original") {
					warnings += " This message may contain a parameter reference suffix of '.original', But CX only supports this for intent parameters (not session parameters)."
				}
				if strings.Contains(t, ".recent") {
					warnings += " This message may contain a parameter reference suffix of '.recent', but CX does not support this."
				}
				if strings.Contains(t, ".partial") {
					warnings += " This message may contain a parameter reference suffix of '.partial', but CX does not support this."
				}
				logIssue("Intent<"+intent2.DisplayName+">.Messages",
					"This intent has a response message. Use fulfillment instead."+warnings+" Message: "+t)
			}
		} else {
			logIssue("Intent<"+intent2.DisplayName+">.Messages",
				"This intent has a non-text response message. See the rich response message information in the migration guide.")
		}
		if message.Platform != proto2.Intent_Message_PLATFORM_UNSPECIFIED {
			logIssue("Intent<"+intent2.DisplayName+">.Platform",
				"This intent has a message with a non-default platform. See the migration guide for advice.")
		}
	}

	return intent3
}

// migrateEntities migrates ES entities to your CX agent
func migrateEntities(ctx context.Context) error {
	var err error

	// Create ES client
	var client2 *v2.EntityTypesClient
	options2 := []option.ClientOption{}
	if len(*v2Region) > 0 {
		options2 = append(options2,
			option.WithEndpoint(*v2Region+"-dialogflow.googleapis.com:443"))
	}
	client2, err = v2.NewEntityTypesClient(ctx, options2...)
	if err != nil {
		return err
	}
	defer client2.Close()
	var parent2 string
	if len(*v2Region) == 0 {
		parent2 = fmt.Sprintf("projects/%s/agent", *v2Project)
	} else {
		parent2 = fmt.Sprintf("projects/%s/locations/%s/agent", *v2Project, *v2Region)
	}

	// Create CX client
	var client3 *v3.EntityTypesClient
	options3 := []option.ClientOption{}
	if len(*v3Region) > 0 {
		options3 = append(options3,
			option.WithEndpoint(*v3Region+"-dialogflow.googleapis.com:443"))
	}
	client3, err = v3.NewEntityTypesClient(ctx, options3...)
	if err != nil {
		return err
	}
	defer client3.Close()
	parent3 := fmt.Sprintf("projects/%s/locations/%s/agents/%s", *v3Project, *v3Region, *v3Agent)

	// Read each V2 entity type, convert, and write to V3
	request2 := &proto2.ListEntityTypesRequest{
		Parent: parent2,
	}
	it2 := client2.ListEntityTypes(ctx, request2)
	for {
		var et2 *proto2.EntityType
		et2, err = it2.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Printf("Entity Type: %s\n", et2.DisplayName)

		if *dryRun {
			convertEntityType(et2)
			continue
		}

		request3 := &proto3.CreateEntityTypeRequest{
			Parent:     parent3,
			EntityType: convertEntityType(et2),
		}
		et3, err := client3.CreateEntityType(ctx, request3)
		entityTypeShortToLong[et3.DisplayName] = et3.Name
		if err != nil {
			return err
		}

		// ES and CX each have a quota limit of 60 design-time requests per minute
		time.Sleep(2 * time.Second)
	}
	return nil
}

// migrateIntents migrates intents to your CX agent
func migrateIntents(ctx context.Context) error {
	var err error

	// Create ES client
	var client2 *v2.IntentsClient
	options2 := []option.ClientOption{}
	if len(*v2Region) > 0 {
		options2 = append(options2,
			option.WithEndpoint(*v2Region+"-dialogflow.googleapis.com:443"))
	}
	client2, err = v2.NewIntentsClient(ctx, options2...)
	if err != nil {
		return err
	}
	defer client2.Close()
	var parent2 string
	if len(*v2Region) == 0 {
		parent2 = fmt.Sprintf("projects/%s/agent", *v2Project)
	} else {
		parent2 = fmt.Sprintf("projects/%s/locations/%s/agent", *v2Project, *v2Region)
	}

	// Create CX client
	var client3 *v3.IntentsClient
	options3 := []option.ClientOption{}
	if len(*v3Region) > 0 {
		options3 = append(options3,
			option.WithEndpoint(*v3Region+"-dialogflow.googleapis.com:443"))
	}
	client3, err = v3.NewIntentsClient(ctx, options3...)
	if err != nil {
		return err
	}
	defer client3.Close()
	parent3 := fmt.Sprintf("projects/%s/locations/%s/agents/%s", *v3Project, *v3Region, *v3Agent)

	// Read each V2 entity type, convert, and write to V3
	request2 := &proto2.ListIntentsRequest{
		Parent:     parent2,
		IntentView: proto2.IntentView_INTENT_VIEW_FULL,
	}
	it2 := client2.ListIntents(ctx, request2)
	for {
		var intent2 *proto2.Intent
		intent2, err = it2.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Printf("Intent: %s\n", intent2.DisplayName)
		intent3 := convertIntent(intent2)
		if intent3 == nil {
			continue
		}

		if *dryRun {
			continue
		}

		request3 := &proto3.CreateIntentRequest{
			Parent: parent3,
			Intent: intent3,
		}
		_, err := client3.CreateIntent(ctx, request3)
		if err != nil {
			return err
		}

		// ES and CX each have a quota limit of 60 design-time requests per minute
		time.Sleep(2 * time.Second)
	}
	return nil
}

// checkFlags checks commandline flags
func checkFlags() error {
	flag.Parse()
	if len(*v2Project) == 0 {
		return fmt.Errorf("Need to supply es-project-id flag")
	}
	if len(*v3Project) == 0 {
		return fmt.Errorf("Need to supply cx-project-id flag")
	}
	if len(*v2Region) == 0 {
		fmt.Printf("No region supplied for ES, using default\n")
	}
	if len(*v3Region) == 0 {
		return fmt.Errorf("Need to supply cx-region-id flag")
	}
	if len(*v3Agent) == 0 {
		return fmt.Errorf("Need to supply cx-agent-id flag")
	}
	if len(*outFile) == 0 {
		return fmt.Errorf("Need to supply out-file flag")
	}
	return nil
}

// closeFile is used as a convenience for defer
func closeFile(f *os.File) {
	err := f.Close()
	if err != nil {
		fmt.Fprintf(os.Stderr, "ERROR closing CSV file: %v\n", err)
		os.Exit(1)
	}
}

func main() {
	if err := checkFlags(); err != nil {
		fmt.Fprintf(os.Stderr, "ERROR checking flags: %v\n", err)
		os.Exit(1)
	}
	ctx := context.Background()
	if err := migrateEntities(ctx); err != nil {
		fmt.Fprintf(os.Stderr, "ERROR migrating entities: %v\n", err)
		os.Exit(1)
	}
	if err := migrateIntents(ctx); err != nil {
		fmt.Fprintf(os.Stderr, "ERROR migrating intents: %v\n", err)
		os.Exit(1)
	}
	csvFile, err := os.Create(*outFile)
	if err != nil {
		fmt.Fprintf(os.Stderr, "ERROR opening output file: %v", err)
		os.Exit(1)
	}
	defer closeFile(csvFile)
	csvWriter := csv.NewWriter(csvFile)
	if err := csvWriter.WriteAll(issues); err != nil {
		fmt.Fprintf(os.Stderr, "ERROR writing CSV output file: %v", err)
		os.Exit(1)
	}
	csvWriter.Flush()
}

Migración de herramientas de los tipos de entidades

Los tipos de entidades de ES y los tipos de entidades de CX son muy similares, por lo que son el tipo de datos más fácil de migrar. La herramienta simplemente copia los tipos de entidades tal como están.

Migración de intents de herramientas

Los intents de ES y los intents de CX son muy diferentes.

Los intents ES se usan como componentes básicos del agente. Contienen frases de entrenamiento, respuestas, contexto para el control de la conversación, la configuración de webhook, eventos, acciones y parámetros de relleno de ranuras.

Dialogflow CX trasladó la mayoría de estos datos a otros recursos. Los intents de CX solo tienen frases y parámetros de entrenamiento, lo que hace que los intents se puedan volver a usar en todo el agente. La herramienta solo copia estos dos tipos de datos de intents en tus intents de CX.

Limitaciones de la Herramienta de migración

La herramienta de migración no es compatible con lo siguiente:

  • Agentes combinados: La herramienta no puede leer de varios agentes secundarios, pero puedes llamar a la herramienta varias veces en cada agente secundario.
  • Agentes multilingües: Debes modificar la herramienta para crear frases de entrenamiento y entradas de entidad multilingües.
  • Verificación de entidades del sistema para idiomas distintos del inglés: La herramienta crea elementos TODO cuando encuentra entidades del sistema que no son compatibles con CX, con la suposición de que el inglés es el idioma predeterminado y que usa una región de EE.UU. La compatibilidad de las entidades del sistema varía según el idioma y la región. Para otros idiomas y regiones, debes modificar la herramienta a fin de realizar esta verificación.

Pasos esenciales de la migración

En las siguientes subsecciones, se describen los pasos de migración que se deben realizar. No es necesario que sigas estos pasos manuales en orden y es posible que debas hacerlos de forma simultánea o en un orden diferente. Lee los pasos y comienza a planificar tus cambios antes de realizarlos realmente.

Después de ejecutar la herramienta de migración, puedes volver a compilar tu agente de CX. Aún tendrás una gran cantidad de trabajo de migración por hacer, pero la mayor parte de los datos ingresados a mano estará presente en tu agente de CX y en el archivo TODO.

Crea tu agente de Dialogflow CX

Si aún no lo hiciste, crea tu agente de Dialogflow CX. Asegúrate de usar el mismo idioma predeterminado que el agente de ES.

Ejecuta la herramienta de migración

Sigue estos pasos para ejecutar la herramienta:

  1. Si aún no lo hiciste, instala Go en tu máquina.
  2. Crea un directorio para el código de la herramienta llamado migrate.
  3. Copia el código de herramienta anterior a un archivo de este directorio llamado main.go.
  4. Modifica el código si es necesario para tu caso.

  5. Crea un módulo de Go en este directorio. Por ejemplo:

    go mod init migrate

  6. Instala las bibliotecas cliente de Dialogflow ES V2 y Dialogflow CX V3 Go:

    go get cloud.google.com/go/dialogflow/apiv2
go get cloud.google.com/go/dialogflow/cx/apiv3

  7. Asegúrate de haber configurado la autenticación de la biblioteca cliente.

  8. Ejecuta la herramienta y guarda el resultado en el archivo:

    go run main.go -es-project-id=<ES_PROJECT_ID> -cx-project-id=<CX_PROJECT_ID> \
-cx-region-id=<CX_REGION_ID> -cx-agent-id=<CX_AGENT_ID> -out-file=out.csv

Solución de problemas de la herramienta de migración

Si experimentas errores cuando ejecutas la herramienta, verifica lo siguiente:

Error Solución
Es un error de RPC que indica que una parte de la frase de entrenamiento menciona un parámetro no definido para el intent. Esto puede suceder si anteriormente usaste la API de ES para crear parámetros de intents de una manera que no era coherente con las frases de entrenamiento. Para solucionar este problema, cambia el nombre del parámetro ES desde la consola, verifica que tus frases de entrenamiento usen el parámetro de forma correcta y, luego, haz clic en Save. Esto también puede ocurrir si tus frases de entrenamiento hacen referencia a parámetros que no existen.

Después de corregir los errores, deberás borrar los intents y entidades del agente de CX antes de volver a ejecutar la herramienta de migración.

Cómo mover datos de intents de ES a CX

La herramienta migra frases y parámetros de entrenamiento de intents a intents de CX, pero hay muchos otros campos de intents de ES para migrar de forma manual.

Un intent de ES puede necesitar una página de CX correspondiente, un intent de CX correspondiente o ambos.

Si se usa una coincidencia de intent de ES para hacer la transición de la conversación de un nodo de conversación en particular a otro, debes tener dos páginas en tu agente relacionadas con este intent:

  • La página original que contiene la ruta del intent, que pasará a la página siguiente: La ruta de intents en la página original puede tener mensajes de entrega de CX similares a las respuestas de intent de ES. Es posible que tengas muchas rutas de intents en esta página. Mientras la página original esté activa, estas rutas de intents pueden realizar la transición de la conversación a muchas rutas posibles. Muchos intents de ES compartirán la misma página original de CX correspondiente.
  • En la página siguiente, que es el destino de transición de la ruta del intent en la página original: La entrega de entrada de CX para la página siguiente puede tener mensajes de entrega de CX similares a las respuestas del intent de ES.

Si un intent de ES contiene parámetros obligatorios, debes crear una página de CX correspondiente con los mismos parámetros en un formulario.

Es común que un intent de CX y una página de CX compartan la misma lista de parámetros, lo que significaría que un solo intent de ES tiene una página de CX correspondiente y un intent de CX correspondiente. Cuando un intent de CX con parámetros en una ruta de intent coincide, la conversación a menudo pasa a una página con los mismos parámetros. Los parámetros extraídos de la coincidencia del intent se propagan a los parámetros de sesión, que están disponibles para completar de forma parcial o total los parámetros del formulario de la página.

Los intents de resguardo y los intents de seguimiento predefinidos no existen en CX. Consulta los intents integrados.

En la siguiente tabla, se describe cómo asignar datos de intents específicos de ES a recursos de CX:

Datos de intents de ES Datos de CX correspondientes Acción obligatoria
Frases de entrenamiento Frases de entrenamiento de intents Migrado por herramienta. La herramienta verifica la compatibilidad con entidades del sistema y crea elementos TODO para las entidades del sistema no compatibles.
Respuestas del agente Mensajes de respuesta de entrega Consulta las respuestas del agente.
Contexto para controlar la conversación Ninguno Consulta Control de la estructura y la ruta de acceso de la conversación.
Configuración de webhook Configuración del webhook de entrega Consulta webhooks.
Eventos Controladores de eventos a nivel de flujo o a nivel de la página Consulta los eventos.
Acciones Etiquetas de webhook de entrega Consulta webhooks.
Parámetros Parámetros de intent o del formulario de la página Se migró a los parámetros de intent por herramienta. Si los parámetros son obligatorios, la herramienta creará elementos TODO para migrar a una página. Consulta los parámetros.
Mensajes de parámetros Mensajes de parámetros del formulario de la página Consulta cómo completar formularios.

Crear flujos

Crea un flujo para cada tema de conversación de alto nivel. Los temas de cada flujo deben ser distintos, de modo que la conversación no pueda alternar con frecuencia entre flujos.

Si usaras un agente combinado, cada agente secundario debería convertirse en uno o más flujos.

Comienza con rutas de conversación básicas

Es mejor probar tu agente con el simulador mientras iteras sobre los cambios. Por lo tanto, en un principio, debes enfocarte en las rutas de conversación básicas al comienzo de la conversación y probarlos a medida que realizas cambios. Una vez que empieces a trabajar, continúa con rutas de conversación más detalladas.

Controladores de estado a nivel de flujo frente a controladores de estado a nivel de página

Cuando crees controladores de estado, considera si deben aplicarse a nivel de flujo o de página. Un controlador a nivel de flujo se encuentra dentro del alcance siempre que el flujo (y, por lo tanto, cualquier página dentro del flujo) está activo. Un controlador a nivel de página solo se encuentra dentro del alcance cuando la página en particular está activa. Los controladores de nivel de flujo son similares a los intents de ES sin contexto de entrada. Los controladores a nivel de página son similares a los intents ES con contexto de entrada.

Código de webhook

Las propiedades de solicitud y respuesta de webhook son diferentes para CX. Consulta la sección de webhooks.

Conectores de conocimiento

CX aún no admite conectores de conocimiento. Deberás implementarlos como intents normales o esperar hasta que Dialogflow CX sea compatible con los conectores de conocimiento.

Configuración de agentes

Revisa la configuración del agente de ES y ajusta la configuración del agente de CX según sea necesario.

Usar el archivo TODO

La herramienta de migración genera un archivo CSV. Los elementos de esta lista se centran en datos particulares que pueden requerir atención. Importa este archivo a una hoja de cálculo. Resuelva cada elemento en la hoja de cálculo, utilizando una columna para marcar la finalización.

Migración del uso de la API

Si tu sistema usa la API de ES para llamadas de tiempo de ejecución o de diseño, deberás actualizar este código a fin de usar la API de CX. Si solo usas las llamadas de detección de intents durante el tiempo de ejecución, esta actualización debería ser bastante sencilla.

Integraciones

Si tu agente usa integraciones, consulta la sección de integraciones y realiza los cambios necesarios.

En las siguientes subsecciones, se describen los pasos de migración recomendados.

Validación

Usa la validación del agente para verificar que el agente siga las prácticas recomendadas.

Prueba la configuración

Mientras realizas los pasos de migración manual anteriores, debes probar tu agente con el simulador. Una vez que el agente parezca estar funcionando, debes comparar las conversaciones entre los agentes de ES y CX, y verificar que el comportamiento sea similar o mejore.

Mientras pruebas estas conversaciones con el simulador, debes crear casos de prueba para evitar regresiones futuras.

Entornos

Revisa tus entornos de ES y actualiza los entornos de CX según sea necesario.