jest-ai/types/matchers.d.ts

Custom jest matchers for testing AI applications

import { z } from 'zod';

declare namespace matchers {
	interface JestAIMatchers<E, R> {
		/**
		 * @description
		 * Assert whether a value is included in the larger AI response through semantic search
		 *
		 * @example
		 * expect('What is your name?').toSemanticallyMatch('Hello, I am a virtual assistant, let's start off with an introduction. What is your first name?')
		 *
		 */
		toSemanticallyMatch(expected?: string): R
		/**
		 * @description
		 * Assert whether a tool has been used in the AI response
		 *
		 * @example
		 * expect(() => callLLM()).toHaveUsedSomeTools(['get_flight_information'])
		 *
		 */
		toHaveUsedSomeTools(expected?: string[]): R
		/**
		 * @description
		 * Assert whether all tools in the list were used in the AI response
		 *
		 * @example
		 * expect(() => callLLM()).toHaveUsedAllTools(['get_flight_information', 'get_flight_status'])
		 *
		 */
		toHaveUsedAllTools(expected?: string[]): R
		/**
		 * @description
		 * Assert whether an AI response matches a Zod schema
		 *
		 * @example
		 * expect(llmResponse).toMatchZodSchema(z.Object({ name: z.string(), age: z.number() }))
		 *
		 */
		toMatchZodSchema(expected?: z.Schema<any, any>): R
		/**
		 * @description
		 * Assert whether an AI response satisfies a true or false statement
		 *
		 * @example
		 * expect(llmResponse).toSatisfyStatement('It contains a question asking for your flight number.')
		 *
		 */
		toSatisfyStatement(expected?: string): R
	}
}

// Needs to extend Record<string, any> to be accepted by expect.extend()
// as it requires a string index signature.
declare const matchers: matchers.JestAIMatchers<any, void> &
	Record<string, any>
export = matchers