Skip to content
Mule0.2.1
API reference

testing

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/mule/testing";

Exports

Section titled “Exports”
Kind Export Description
type alias FauxModelDefinition Credential-free model definition for the scripted provider.
type alias RegisterFauxProviderOptions Scripted provider configuration, independent of provider SDK declarations.
type alias FauxProviderState Counters retained by the scripted provider.
type alias FauxResponseFactory Function that observes a model request and supplies a scripted reply.
type alias FauxResponseStep A scripted reply or a factory that observes the normalized request.
type alias FauxModel Deterministic model and stream with Pi’s observable response state.
function fauxModel() Create a credential-free model for tests and runnable examples.

FauxModelDefinitiontype alias

Section titled “FauxModelDefinition”
Signature
type FauxModelDefinition = object;

Credential-free model definition for the scripted provider.

Properties

Section titled “Properties”

id

Section titled “id”
Signature
id: string;

name?

Section titled “name?”
Signature
optional name?: string;

reasoning?

Section titled “reasoning?”
Signature
optional reasoning?: boolean;

input?

Section titled “input?”
Signature
optional input?: ("text" | "image")[];

inputLimits?

Section titled “inputLimits?”
Signature
optional inputLimits?: Model<Api>["inputLimits"];

cost?

Section titled “cost?”
Signature
optional cost?: object;
input
Section titled “input”
Signature
input: number;
output
Section titled “output”
Signature
output: number;
cacheRead
Section titled “cacheRead”
Signature
cacheRead: number;
cacheWrite
Section titled “cacheWrite”
Signature
cacheWrite: number;

contextWindow?

Section titled “contextWindow?”
Signature
optional contextWindow?: number;

maxTokens?

Section titled “maxTokens?”
Signature
optional maxTokens?: number;

RegisterFauxProviderOptionstype alias

Section titled “RegisterFauxProviderOptions”
Signature
type RegisterFauxProviderOptions = object;

Scripted provider configuration, independent of provider SDK declarations.

Properties

Section titled “Properties”

api?

Section titled “api?”
Signature
optional api?: string;

provider?

Section titled “provider?”
Signature
optional provider?: string;

models?

Section titled “models?”
Signature
optional models?: FauxModelDefinition[];

deferred?

Section titled “deferred?”
Signature
optional deferred?: object;
pendingFetches?
Section titled “pendingFetches?”
Signature
optional pendingFetches?: number;
pollAfterMs?
Section titled “pollAfterMs?”
Signature
optional pollAfterMs?: number;

tokensPerSecond?

Section titled “tokensPerSecond?”
Signature
optional tokensPerSecond?: number;

tokenSize?

Section titled “tokenSize?”
Signature
optional tokenSize?: object;
min?
Section titled “min?”
Signature
optional min?: number;
max?
Section titled “max?”
Signature
optional max?: number;

FauxProviderStatetype alias

Section titled “FauxProviderState”
Signature
type FauxProviderState = object;

Counters retained by the scripted provider.

Properties

Section titled “Properties”

callCount

Section titled “callCount”
Signature
callCount: number;

deferredFetchCount

Section titled “deferredFetchCount”
Signature
deferredFetchCount: number;

cancelledDeferred

Section titled “cancelledDeferred”
Signature
cancelledDeferred: NonNullable < AssistantMessage["deferred"] > [];

FauxResponseFactorytype alias

Section titled “FauxResponseFactory”
Signature
type FauxResponseFactory = (
  context,
  options,
  state,
  model,
) => AssistantMessage | Promise<AssistantMessage>;

Function that observes a model request and supplies a scripted reply.

Parameters

Section titled “Parameters”
Parameter Type
context Context
options Parameters<MuleStreamFunction>[2]
state FauxProviderState
model Model<Api>

Returns

Section titled “Returns”

| AssistantMessage | Promise<AssistantMessage>

FauxResponseSteptype alias

Section titled “FauxResponseStep”
Signature
type FauxResponseStep = AssistantMessage | FauxResponseFactory;

A scripted reply or a factory that observes the normalized request.

FauxModeltype alias

Section titled “FauxModel”
Signature
type FauxModel = Readonly<{
  model: Model<Api>;
  stream: (...args) => AssistantMessageEventStream;
  retryable: (message) => boolean;
  setResponses: (replies) => void;
  state: FauxProviderState;
  getPendingResponseCount: () => number;
}>;

Deterministic model and stream with Pi’s observable response state.

fauxModel()function

Section titled “fauxModel()”
Signature
function fauxModel(replies, options?): FauxModel;

Create a credential-free model for tests and runnable examples.

Parameters

Section titled “Parameters”
Parameter Type
replies readonly FauxResponseStep[]
options RegisterFauxProviderOptions

Returns

Section titled “Returns”

FauxModel