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

AxAIAnthropicChatRequest

TypeScript
type AxAIAnthropicChatRequest = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L134

Properties

anthropic_version?

TypeScript
optional anthropic_version: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L136


max_tokens?

TypeScript
optional max_tokens: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L210


messages

TypeScript
messages: (
  | {
  content:   | string
     | object & AxAIAnthropicChatRequestCacheParam[];
  role: "system";
}
  | {
  content: string | (... & ... | ... & ... | ... & ...)[];
  role: "user";
}
  | {
  content:   | string
     | (
     | ... & ...
     | {
     signature?: string;
     thinking: string;
     type: "thinking";
   }
     | {
     data: string;
     signature?: string;
     type: "redacted_thinking";
   }
     | ... & ...)[];
  role: "assistant";
})[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L137


metadata?

TypeScript
optional metadata: object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L226

user_id

TypeScript
user_id: string;

model?

TypeScript
optional model: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L135


output_config?

TypeScript
optional output_config: AxAIAnthropicOutputConfig;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L224


speed?

TypeScript
optional speed: "fast";

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L225


stop_sequences?

TypeScript
optional stop_sequences: string[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L212


stream?

TypeScript
optional stream: boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L213


system?

TypeScript
optional system: 
  | string
  | object & AxAIAnthropicChatRequestCacheParam[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L214


temperature?

TypeScript
optional temperature: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L220


thinking?

TypeScript
optional thinking: AxAIAnthropicThinkingWire;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L223


tool_choice?

TypeScript
optional tool_choice: 
  | {
  type: "auto" | "any";
}
  | {
  name?: string;
  type: "tool";
};

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L209


tools?

TypeScript
optional tools: AxAIAnthropicRequestTool[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L208


top_k?

TypeScript
optional top_k: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L222


top_p?

TypeScript
optional top_p: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/anthropic/types.ts#L221

Docs