AxMockAIServiceConfig Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxMockAIServiceConfig.md type AxMockAIServiceConfig

AxMockAIServiceConfig

TypeScript
type AxMockAIServiceConfig<TModelKey> = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L23

Type Parameters

Type Parameter
TModelKey

Properties

chatResponse?

TypeScript
optional chatResponse: 
  | AxChatResponse
  | ReadableStream<AxChatResponse>
  | () => Promise<
  | AxChatResponse
  | ReadableStream<AxChatResponse>>
  | (req: Readonly<AxChatRequest<unknown>>, options?: Readonly<AxAIServiceOptions>) => Promise<
  | AxChatResponse
| ReadableStream<AxChatResponse>>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L36


embedModelInfo?

TypeScript
optional embedModelInfo: AxModelInfoWithProvider;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L27


embedResponse?

TypeScript
optional embedResponse: 
  | AxEmbedResponse
  | (req: Readonly<AxEmbedRequest>) => 
  | AxEmbedResponse
| Promise<AxEmbedResponse>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L45


errorMessage?

TypeScript
optional errorMessage: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L61


features?

TypeScript
optional features: object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L28

functions?

TypeScript
optional functions: boolean;

media?

TypeScript
optional media: Partial<AxAIFeatures["media"]>;

streaming?

TypeScript
optional streaming: boolean;

structuredOutputs?

TypeScript
optional structuredOutputs: boolean;

id?

TypeScript
optional id: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L25


latencyMs?

TypeScript
optional latencyMs: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L62


modelInfo?

TypeScript
optional modelInfo: Partial<AxModelInfoWithProvider>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L26


models?

TypeScript
optional models: AxAIModelList<TModelKey>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L34


name?

TypeScript
optional name: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L24


options?

TypeScript
optional options: AxAIServiceOptions;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L35


shouldError?

TypeScript
optional shouldError: boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L60


speechResponse?

TypeScript
optional speechResponse: 
  | AxSpeechResponse
  | (req: Readonly<AxSpeechRequest<unknown>>) => 
  | AxSpeechResponse
| Promise<AxSpeechResponse>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L55


transcribeResponse?

TypeScript
optional transcribeResponse: 
  | AxTranscriptionResponse
  | (req: Readonly<AxTranscriptionRequest<unknown>>) => 
  | AxTranscriptionResponse
| Promise<AxTranscriptionResponse>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/mock/api.ts#L50

Docs