agents / Exports / ChatOptions
Interface: ChatOptions
Options for AI provider chat requests
Hierarchy
ProviderSpecificOptions↳
ChatOptions
Table of contents
Properties
Properties
openai
• Optional openai: Object
OpenAI specific options
Type declaration
| Name | Type |
|---|---|
organization? | string |
user? | string |
stop? | string | string[] |
presencePenalty? | number |
frequencyPenalty? | number |
logitBias? | Record<string, number> |
topP? | number |
n? | number |
stream? | boolean |
suffix? | string |
echo? | boolean |
bestOf? | number |
logprobs? | number |
Inherited from
ProviderSpecificOptions.openai
Defined in
packages/agents/src/interfaces/provider.ts:109
anthropic
• Optional anthropic: Object
Anthropic specific options
Type declaration
| Name | Type |
|---|---|
stopSequences? | string[] |
topP? | number |
topK? | number |
metadata? | { userId?: string } |
metadata.userId? | string |
Inherited from
ProviderSpecificOptions.anthropic
Defined in
packages/agents/src/interfaces/provider.ts:126
google
• Optional google: Object
Google specific options
Type declaration
| Name | Type |
|---|---|
candidateCount? | number |
stopSequences? | string[] |
safetySettings? | { category: string ; threshold: string }[] |
topP? | number |
topK? | number |
Inherited from
ProviderSpecificOptions.google
Defined in
packages/agents/src/interfaces/provider.ts:136
tools
• Optional tools: ToolSchema[]
Tool schemas to provide to the AI provider
Defined in
packages/agents/src/interfaces/provider.ts:153
maxTokens
• Optional maxTokens: number
Maximum number of tokens to generate
Defined in
packages/agents/src/interfaces/provider.ts:155
temperature
• Optional temperature: number
Temperature for response randomness (0-1)
Defined in
packages/agents/src/interfaces/provider.ts:157
model
• Optional model: string
Model to use for the request