<!--
 ⚠️  AUTO-GENERATED FILE - DO NOT EDIT MANUALLY
 This file is automatically generated by scripts/docs-generator.js
 To make changes, edit the source TypeScript files or update the generator script
-->

[agents](../../) / [Exports](../modules) / IChatOptions

# Interface: IChatOptions

Options for AI provider chat requests

## Hierarchy

- [`IProviderSpecificOptions`](IProviderSpecificOptions)

  ↳ **`IChatOptions`**

## Table of contents

### Properties

- [openai](IChatOptions#openai)
- [anthropic](IChatOptions#anthropic)
- [google](IChatOptions#google)
- [tools](IChatOptions#tools)
- [maxTokens](IChatOptions#maxtokens)
- [temperature](IChatOptions#temperature)
- [model](IChatOptions#model)

## 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

[IProviderSpecificOptions](IProviderSpecificOptions).[openai](IProviderSpecificOptions#openai)

#### Defined in

[packages/agents/src/interfaces/provider.ts:97](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L97)

---

### 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

[IProviderSpecificOptions](IProviderSpecificOptions).[anthropic](IProviderSpecificOptions#anthropic)

#### Defined in

[packages/agents/src/interfaces/provider.ts:114](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L114)

---

### 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

[IProviderSpecificOptions](IProviderSpecificOptions).[google](IProviderSpecificOptions#google)

#### Defined in

[packages/agents/src/interfaces/provider.ts:124](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L124)

---

### tools

• `Optional` **tools**: [`IToolSchema`](IToolSchema)[]

Tool schemas to provide to the AI provider

#### Defined in

[packages/agents/src/interfaces/provider.ts:141](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L141)

---

### maxTokens

• `Optional` **maxTokens**: `number`

Maximum number of tokens to generate

#### Defined in

[packages/agents/src/interfaces/provider.ts:143](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L143)

---

### temperature

• `Optional` **temperature**: `number`

Temperature for response randomness (0-1)

#### Defined in

[packages/agents/src/interfaces/provider.ts:145](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L145)

---

### model

• `Optional` **model**: `string`

Model to use for the request

#### Defined in

[packages/agents/src/interfaces/provider.ts:147](https://github.com/woojubb/robota/blob/4f4c8a3197e92ddd43d12dc9186b0771983054c9/packages/agents/src/interfaces/provider.ts#L147)
