SDK Flutter

O colaborador de IA da ORYKSA dentro de um app Flutter: o mesmo chat do site, em quatro idiomas, com um Brain que aprende o app.

O que o SDK faz e para que serve

Coloca no seu app o balão de chat e a voz da ORYKSA para atender os clientes da sua empresa: eles perguntam, compram e agendam. A IA responde com o seu Brain, os seus produtos e os seus serviços, com o nome, a foto e a voz que você escolheu em Sua IA, e registra leads, agendamentos e vendas nas Atividades da sua conta ORYKSA, como no WhatsApp ou no chat do site.

Não é uma interface do dono: pelo SDK ninguém altera as suas configurações, lê as suas Atividades ou dá ordens à ORYKSA, mesmo dizendo que é o dono. O chat em que o dono fala com a ORYKSA existe só no app ORYKSA oficial, no painel e na extensão do navegador.

Voz desde a versão 1.1 (Android, iOS, Flutter e React Native), com o mesmo comportamento do app ORYKSA. Os SDKs JavaScript e .NET são só texto.

Os palavrões que o cliente digita aparecem com asteriscos no chat (a mesma lista de todos os chats da ORYKSA, em GET https://app.oryksa.com/widget/profanity.json); as respostas da IA já vêm filtradas.

Saiba mais na Central de Ajuda

Instalar

flutter pub add oryksa

Exemplo mínimo

Um botão flutuante que abre o chat. O botão mostra "Falar com <nome>" com a foto do colaborador de IA, exatamente como o chat do site.

import 'package:oryksa/oryksa.dart';

// The app never holds the API key: your backend creates short-lived
// session tokens (oryk_cs_...) with POST /v1/sessions and hands them over.
final client = OryksaClient(
  getToken: () async => await myBackend.fetchOryksaToken(),
);

Scaffold(
  body: MyScreen(),
  floatingActionButton: OryksaChatButton(client: client, lang: 'en'), // en, pt, br, es
);

Peças

Lado do servidor (Dart)

A chave de API fica no seu servidor. Seu backend cria os tokens de sessão que o app usa e mantém o Brain do agente sincronizado com o app por meio do learnApp.

import 'dart:io';
import 'package:oryksa/oryksa_server.dart';   // backend only: never import it in the app

final oryksa = Oryksa(Platform.environment['ORYKSA_API_KEY']!);
// short-lived token for one app user: send only client_token to the app
final session = await oryksa.createSession(conversationId: 'user-42', customerName: 'Ana');
// keep the Brain in sync with the app (call it on every release)
await oryksa.learnApp(name: 'My app', screens: appScreens, faq: appFaq);
// webhooks: pass the RAW body
final event = verifyWebhook(rawBody, request.headers['oryksa-signature'], webhookSecret);

O que o usuário vê

• O mesmo visual do chat do site: botão com a foto, cabeçalho com o nome e "online", balões, sugestões, ENVIAR e "Powered by ORYKSA".
• Idiomas: en, pt (Portugal), br (Brasil), es. O nome e a foto vêm do perfil "Sua IA" do dono.
• Voz (desde a 1.1): o microfone no chat abre a tela de voz, com o mesmo comportamento do app ORYKSA. Cada resposta tem um botão de copiar.