¿Cómo ejecutar acciones sobre un documento desde el Chatbot en la vista del documento?

Desde un documento puedes acceder a un chatbot para hacerle preguntas sobre el contenido de dicho documento o mismo para ejecutar ciertas acciones sobre el mismo. Para comenzar, puedes verificar cómo configurarlo en este enlace.

Para esta funcionalidad es necesario también poner la setting OPENAI_USE_FUNCTION_CALLS con valor en True, por lo que si no cuentas con permisos, debes ponerte en contacto con un administrador de la instancia para realizar esta configuración.

Las funciones que actualmente se encuentran disponibles desde el chatbot son las siguientes:

• update_document: Permite actualizar el título o los metadatos del documento.
• update_document_life_cycle_state: Permite actualizar el estado del ciclo de vida del documento.
• run_operation: Permite ejecutar una operación sobre el documento.
• create_document: Permite crear documentos en el espacio y tipo documental indicados. Es posible también indicar el título y valores de los metadatos al momento de la creación.

Estas acciones o funciones que se pueden ejecutar se encuentran únicamente disponibles utilizando los asistentes de OpenAI. Puedes ver más sobre esto aquí.

Para habilitar estas funciones debes contar con un asistente ya creado. Debes dirigirte a dicho asistente desde el siguiente enlace.

El asistente debe contar con instrucciones de sistema para que sepa cómo proceder ante cada solicitud que se le haga desde el chatbot. Si bien puedes configurar las instrucciones para adaptarse a tu caso particular, a continuación se comparten unas instrucciones de base con las cuáles el asistente detecta correctamente la solicitud de ejecución de cualquiera de las funciones u operaciones:

"Eres un experto en XXXX . Ayudas a  XXXXX.

Cuando el usuario pida realizar alguna acción sobre el documento, debes buscar dentro de las funciones cuál es la más acorde a ejecutar. Luego, si no hay funciones, busca dentro de las operaciones proporcionadas para ejecutar la operación más acorde sobre dicho documento."

Para poder configurar el asistente para que reconozca las funciones que puede llamar, debes también añadir dichas funciones en el apartado Functions, dandole click al siguiente botón:

Cada función necesita ser definida en un JSON Schema, lo cual enriquece la configuración que se le puede dar a la misma. A continuación puedes encontrar las definiciones de cada una de las funciones disponibles:

{
  "name": "update_document",
  "description": "Update the metadata or the filename of a document",
  "strict": false,
  "parameters": {
    "type": "object",
    "properties": {
      "document_uuid": {
        "type": "string",
        "description": "UUID of the document"
      },
      "data": {
        "type": "object",
        "properties": {
          "metadata": {
            "type": "object",
            "description": "Metadata of the document that will be updated. Only needs to be specified if asked to update metadata. Keys must follow the pattern 'metadata.<metadata_name>', and values must be strings.",
            "patternProperties": {
              "^metadata\\..+$": {
                "type": "string"
              }
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "filename": {
            "type": "string",
            "description": "New filename of the document. Only needs to be specified if the filename of the document is changed."
          }
        }
      }
    },
    "required": [
      "document_uuid",
      "data"
    ]
  }
}

{
  "name": "update_document_life_cycle_state",
  "description": "Update the life cycle state of a document",
  "strict": false,
  "parameters": {
    "type": "object",
    "properties": {
      "document_uuid": {
        "type": "string",
        "description": "UUID of the document"
      },
      "destination_state_uuid": {
        "type": "string",
        "description": "UUID of the destination state"
      }
    },
    "required": [
      "document_uuid",
      "destination_state_uuid"
    ]
  }
}

{
  "name": "run_operation",
  "description": "Run an operation over the document",
  "strict": false,
  "parameters": {
    "type": "object",
    "properties": {
      "document_uuid": {
        "type": "string",
        "description": "UUID of the document"
      },
      "operation_uuid": {
        "type": "string",
        "description": "UUID of the operation to run"
      }
    },
    "required": [
      "document_uuid",
      "operation_uuid"
    ]
  }
}

{
  "name": "create_document",
  "description": "Create a new document",
  "strict": false,
  "parameters": {
    "type": "object",
    "properties": {
      "filename": {
        "type": "string",
        "description": "Filename of the document"
      },
      "serie_uuid": {
        "type": "string",
        "description": "UUID of the serie"
      },
      "doctype_uuid": {
        "type": "string",
        "description": "UUID of the document type"
      },
      "data": {
        "type": "object",
        "description": "Extra data for document creation.",
        "required": [
          "metadata"
        ],
        "properties": {
          "metadata": {
            "type": "object",
            "description": "Metadata of the document to create. Only needs to be specified if the new document must contain certain values for its metadata. Keys must follow the pattern 'metadata.<metadata_name>', and values must be strings",
            "patternProperties": {
              "^metadata\\..+$": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "required": [
      "filename",
      "serie_uuid",
      "doctype_uuid",
      "data"
    ]
  }
}

Teniendo configurado lo anterior, puedes proceder a solicitarle acciones sobre el documento al asistente a través del chatbot: