OAssist v1.0.0

Requirements

• WordPress 6.0 or newer
• PHP 8.0 or newer
• An API key from one of: OpenAI, Anthropic (Claude), Google (Gemini), Groq
• WooCommerce is optional. With it: order, product, and subscription tools become available.
• At least one Orravo Core install if you want license-managed updates (optional).

From WordPress admin

Manual (FTP / SFTP)

Engine map

Engine toggles

Each engine is gated by a setting in oassist_engines. The Indexer is required; the others fail open. Disable the Tools engine if you only want a documentation chatbot; disable Channels if you only need the website widget.

PHP// Programmatic toggle
$engines = get_option( 'oassist_engines', [] );
$engines['tools']     = false;       // disable WooCommerce tool dispatch
$engines['channels']  = true;        // enable WhatsApp / email / SMS bridging
$engines['budget']    = true;        // recommended
update_option( 'oassist_engines', $engines );

Supported providers

Configure a provider

PHP// PHP API
OA_Providers::configure( 'openai', [
    'api_key'         => 'sk-...',
    'chat_model'      => 'gpt-4o-mini',
    'embedding_model' => 'text-embedding-3-small',
    'temperature'     => 0.4,
    'max_tokens'      => 1024,
] );

// Read current config (api_key returned masked: sk-***...XYZ)
$cfg = OA_Providers::get( 'openai' );

Multi-provider routing

Set a primary and a fallback provider under Providers → Routing. If the primary returns a 429 or 5xx, OAssist retries the same prompt on the fallback. Useful when the primary is rate-limited (Groq) and the fallback is a paid tier (OpenAI).

Floating widget

Shortcode

HTML[oassist]
[oassist mode="inline" theme="light"]
[oassist mode="inline" greeting="Ask anything about WP-Tuner" starters="Pricing|Refunds|API docs"]
[oassist hide_floating="1"]

Setting knowledge="docs,pricing" restricts retrieval to documents tagged with those KB categories. Useful for product-specific embeds (one shortcode per product page, each scoped to its own docs subset).

JS init

JS// Boot OAssist programmatically (e.g. inside a SPA route change)
window.OAssist?.boot({
  mode:     'floating',
  theme:    'dark',
  greeting: 'Hi! Ask me anything about your subscription.',
  context:  { user_id: 142, plan: 'pro' }, // merged into the system prompt
  onOpen:   () => { console.log('widget opened'); },
  onMessage:(m)=> { console.log('message', m); },
});

Endpoints

Send a message

cURLcurl -N -X POST https://example.com/wp-json/oassist/v1/chat/message \
  -H 'Content-Type: application/json' \
  -H 'X-OA-Nonce: <session-nonce>' \
  -d '{
    "conversation_id": "c_2u9pE...",
    "message": "Where is my order #1043?",
    "page_url": "https://example.com/my-account/",
    "context": { "user_id": 142 }
  }'

The response is a Server-Sent Events stream. Each event is either a delta (token chunk), a tool_call (engine dispatched a WooCommerce tool), a tool_result (tool returned), an escalation (sensitive intent detected), or a terminal done event with usage and cost.

Register a custom tool

PHPadd_action( 'oassist_register_tools', function( OA_Tools $tools ) {
    $tools->register([
        'name'        => 'check_inventory',
        'description' => 'Return stock quantity for a product SKU.',
        'parameters'  => [
            'type' => 'object',
            'properties' => [
                'sku' => [ 'type' => 'string', 'description' => 'Product SKU' ],
            ],
            'required' => [ 'sku' ],
        ],
        'callback' => function( array $args ): array {
            $product = wc_get_product( wc_get_product_id_by_sku( $args['sku'] ) );
            if ( ! $product ) {
                return [ 'ok' => false, 'error' => 'unknown_sku' ];
            }
            return [
                'ok'    => true,
                'stock' => (int) $product->get_stock_quantity(),
            ];
        },
    ]);
} );