Skip to main content

CreateAiSessionProps

Interface for creating a chat session between a user and an AI participant. Requires Socket.IO connection to receive AI replies.

Kind: Interface
Package: @ovok/core

Import​

import { CreateAiSessionProps } from '@ovok/core';

TypeScript shape​

interface CreateAiSessionProps {
    assistant: {
        system: string;
        participant: string;
        history: number;
        context: string[];
    };
    title: string;
    participant?: string;
    messages: {
        sender: string;
        content: string;
    }[];
}

This is a type-level export; it has no call parameters.

Public members​

MemberTypeDetails
assistant{ system: string; participant: string; history: number; context: string[]; }Configuration for the AI assistant
titlestringTitle of the chat session
participantstringOptional. The Patient resource reference that represents the user, if not provided, the current user will be used Format: "Patient/{id}"
messages{ sender: string; content: string; }[]Initial messages to start the conversation

Learn the workflow​

Continue with Client Configuration for the workflow context and examples.

Source​

View the declaration in the SDK source.