assistan-ts/src/__tests__/definition.spec.ts

A typesafe and code-first library to define and run OpenAI assistants

import { expect, test } from "bun:test";
import { definition, toPayload } from "../definition";
import { Type } from "..";

import { RequiredActionFunctionToolCall } from "openai/resources/beta/threads/runs/runs";

function sumToolCall(args: string): RequiredActionFunctionToolCall {
  return {
    id: "123",
    type: "function",
    function: {
      arguments: args,
      name: "sum",
    },
  };
}

const onePlusTwo = sumToolCall(`{"a": 1, "b": 2}`);

/* happy :) */

test("translates to OpenAI schema", async () => {
  const adderDef = definition({
    key: "adder",
    model: "gpt-4",
    name: "adder",
    instructions: "You are a calculator",
    codeInterpreter: true,
    retrieval: true,

    functionTools: {
      sum: {
        parameters: Type.Object({
          a: Type.Number(),
          b: Type.Number(Type.Number()),
        }),
      },
      noop: {
        parameters: Type.Null(),
      },
    },
    metadata: { foo: "value" },
    files: {
      file_ids: ["123"],
    },
  });

  const oaiDef = toPayload(adderDef);
  expect(oaiDef.tools?.length).toBe(4);
  expect((oaiDef.metadata as any)["foo"]).toBe("value");
  expect(JSON.stringify(oaiDef, null, 2)).toMatchSnapshot();
});

test("without other tools", async () => {
  const adderDef = definition({
    key: "adder",
    model: "gpt-4",
    name: "adder",
    instructions: "You are a calculator",
    codeInterpreter: false,
    retrieval: false,
    functionTools: {
      sum: {
        parameters: Type.Object({
          a: Type.Number(),
          b: Type.Number(Type.Number()),
        }),
      },
      noop: {
        parameters: Type.Null(),
      },
    },
  });

  const oaiDef = toPayload(adderDef);
  expect(oaiDef.tools?.length).toBe(2);
  expect(JSON.stringify(oaiDef, null, 2)).toMatchSnapshot();
});