Apex OpenAI Assistants

Library for working with OpenAI Assistants in Salesforce Apex.

Warning: WIP. Incomplete & API likely to change.

Setup

Sign-up for OpenAI and create an API key
Install
Configure Named Credential for OpenAI API (todo: instructions)
Assign Permission set sfdx force:user:permset:assign -n OpenAI

Usage

Configure the Assistant

Create an OpenAI Assistant (using Open AI Playground or API). Grab the assistant ID for later. See force-app/main/example/demoAssistant.json for example json.

Define an IAssistant with matching "tools" and an handle to execute after each "run" completion.

public class DemoAssistant implements IAssistant  {

    public static String ASSISTANT_ID = 'YOUR_ASSISTANT_ID';

    public Map<string, IAssistantTool> getToolBox(){
        return new Map<String, IAssistantTool> {
            'run_soql' => new RunSOQLTool()
        };
    }

    public void onRunComplete(OpenAiApi.Run run){
        //this is where you'd do something with the run results, such as save messages to a custom object
        System.debug(OpenAiApi.listMessages(run.thread_id));
    }

    public class RunSOQLTool implements IAssistantTool {
        public String execute(Map<String, Object> args) {
            String query = (String) args.get('query');
            return JSON.serialize(Database.query(query));
        }
    }
}

See force-app/main/example for complete example

Run The Assistant

OpenAiApi.RequestMessage[] messages = new OpenAiApi.RequestMessage[] {
    new OpenAiApi.RequestMessage('user', 'Whats the name of the most recently created account.')
};

String threadId = OpenAiApi.createThread(messages, null);

// Poll the run
AssistantRunQueuable run = new AssistantRunQueuable(threadId, new DemoAssistant());
run.startRun();

Later, you may add more messages and run again:

String threadId = '...'; // you'd need to persist the threadId somewhere
OpenAiApi.createMessage(threadId, new OpenAiApi.RequestMessage('user', 'Give me the last contact created'));
AssistantRunQueuable run = new AssistantRunQueuable(threadId, new DemoAssistant());
run.startRun();

How to integrate with a Client UI

In order to build a client UI in Salesforce that can interact with the assistant, you'll likely want to create a custom object(s) that tracks the threads and gets updated each time a run completes. This would make it easier to trigger UI updates when the run completes. It also allows you to persist the threadId so that you can add messages to the thread later.

Alternatively, you could just have the client itself poll OpenAIApi.getRun(runId) until the run status=complete.

ChuckJonas / apex-openai-assistants