AssistantsPlannerOptions interface
Options for configuring the AssistantsPlanner.
Properties
| api |
The OpenAI or Azure OpenAI API key. |
| assistants_state_variable | Optional. The state variable to use for storing the assistants state. |
| assistant_id | The ID of the assistant to use. |
| endpoint | The Azure OpenAI resource endpoint. |
| polling_interval | Optional. Polling interval in milliseconds. |
Property Details
apiKey
The OpenAI or Azure OpenAI API key.
apiKey: stringProperty Value
string
assistants_state_variable
Optional. The state variable to use for storing the assistants state.
assistants_state_variable?: stringProperty Value
string
Remarks
Defaults to 'conversation.assistants_state'.
assistant_id
The ID of the assistant to use.
assistant_id: stringProperty Value
string
endpoint
The Azure OpenAI resource endpoint.
endpoint?: stringProperty Value
string
polling_interval
Optional. Polling interval in milliseconds.
polling_interval?: numberProperty Value
number
Remarks
Defaults to 1000 (once a second).