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

AxAIWebLLMChatRequest

TypeScript
type AxAIWebLLMChatRequest = object;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L64

WebLLM: Chat request structure Based on OpenAI-compatible API from WebLLM

Properties

frequency_penalty?

TypeScript
optional frequency_penalty: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L97


logit_bias?

TypeScript
optional logit_bias: Record<number, number>;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L98


logprobs?

TypeScript
optional logprobs: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L99


max_tokens?

TypeScript
optional max_tokens: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L93


messages

TypeScript
messages: (
  | {
  content?: string;
  name?: string;
  role: "system" | "user";
}
  | {
  content?: string;
  name?: string;
  role: "assistant";
  tool_calls?: object[];
}
  | {
  content: string;
  role: "tool";
  tool_call_id: string;
})[];

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L66


model

TypeScript
model: AxAIWebLLMModelId;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L65


n?

TypeScript
optional n: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L104


presence_penalty?

TypeScript
optional presence_penalty: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L96


response_format?

TypeScript
optional response_format: 
  | {
  type: "json_object";
}
  | {
  json_schema?: unknown;
  type: "json_schema";
};

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L101


stop?

TypeScript
optional stop: string | string[];

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L95


stream?

TypeScript
optional stream: boolean;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L94


stream_options?

TypeScript
optional stream_options: object;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L105

include_usage?

TypeScript
optional include_usage: boolean;

temperature?

TypeScript
optional temperature: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L91


tool_choice?

TypeScript
optional tool_choice: 
  | "none"
  | "auto"
  | "required"
  | {
  function: {
     name: string;
  };
  type: "function";
};

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L116


tools?

TypeScript
optional tools: object[];

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L108

function

TypeScript
{
  description: string;
  name: string;
  parameters: object;
}

type

TypeScript
type: "function";

top_logprobs?

TypeScript
optional top_logprobs: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L100


top_p?

TypeScript
optional top_p: number;

Defined in: https://github.com/ax-llm/ax/blob/3306475085414d36aee4411ad2466e08e53bef8a/src/ax/ai/webllm/types.ts#L92

Docs