Portal de IA | Plazbot Docs

Introduccion

Con el SDK de Plazbot puedes crear Portales de IA con experiencia tipo ChatGPT para tus clientes. Implementa IA para Atencion al Cliente, Ventas, Soporte y mas.

Inicializacion

Plazbot (recomendado)·ts

01import { Plazbot } from 'plazbot';
02 
03const plazbot = new Plazbot({
04  workspaceId: "YOUR_WORKSPACE_ID",
05  apiKey: "YOUR_API_KEY",
06  zone: "LA"
07});
08 
09// Usar: plazbot.portal.addPortal(...)

Creacion del Portal

Crea un nuevo portal con la configuracion de interfaz (titulo, subtitulo, marca, tema).

Es fundamental asociar al menos un agente a un portal para que funcione. Sin agentes asociados, el portal no se cargara.

Importante: Los agentes asociados a Portales deben tener useToolCalling: true activado para que el streaming SSE funcione correctamente. Los nuevos agentes ya se crean con esta opcion activada por defecto.

Con un portal puedes tener multiples agentes: uno para Ventas, otro para Soporte, otro para Atencion al Cliente, etc.

01const portalCreated = await plazbot.portal.addPortal({
02  name: "Portal de Busqueda",
03  zone: "LA",
04  title: "Centro de Ayuda",
05  subtitle: "Pregunta lo que necesites",
06  logo: "https://tu-dominio.com/logo.png",
07  logodark: "https://tu-dominio.com/logo-dark.png",
08  access: "direct",  // "direct" o "form"
09  theme: "light",     // "light" o "dark"
10  disabled: false,
11  brandOff: false,
12});
13 
14const portalId = portalCreated.id;
15const portalUrl = portalCreated.url;

Al crear el portal recibiras la URL publica:

code

01https://appla.plazbot.com/portal?id={PORTAL_ID}&workspaceId={WORKSPACE_ID}

Campos del Portal

Campo	Tipo	Descripcion
`name`	`string`	Nombre del portal
`title`	`string`	Titulo que aparece en la parte superior
`subtitle`	`string`	Texto descriptivo debajo del titulo
`logo`	`string`	URL del logo en modo claro (PNG/JPG)
`logodark`	`string`	URL del logo en modo oscuro (PNG/JPG)
`access`	`string`	`"direct"` o `"form"`
`theme`	`string`	`"light"` o `"dark"`
`disabled`	`boolean`	Activar/desactivar portal
`brandOff`	`boolean`	Ocultar marca Plazbot
`zone`	`string`	`"LA"` o `"EU"`

Asociar Agente al Portal

01await plazbot.portal.addAgentToPortal({
02  portalId: portalId,
03  id: agentId
04});

Remover Agente del Portal

01await plazbot.portal.removeAgentFromPortal({
02  portalId: portalId,
03  id: agentId
04});

Agregar Links al Portal

Agrega enlaces externos al portal. Maximo 5 enlaces. Se abren en una nueva ventana.

01await plazbot.portal.addLinkToPortal({
02  portalId: portalId,
03  value: "Blog",
04  url: "https://www.plazbot.com/blog"
05});
06 
07await plazbot.portal.addLinkToPortal({
08  portalId: portalId,
09  value: "Documentacion",
10  url: "https://docs.plazbot.com"
11});

Obtener Portal

01const portalInfo = await plazbot.portal.getPortal(portalId);

Limpiar Links

Elimina todos los links configurados del portal.

01await plazbot.portal.clearLinks(portalId);

Actualizar Portal

01await plazbot.portal.updatePortal({
02  id: portalId,
03  name: "Portal Actualizado",
04  theme: "dark"
05});

Eliminar Portal

01await plazbot.portal.deletePortal(portalId);