Share via

AssistantsPlannerOptions interface

  • Reference
Package:
@microsoft/teams-ai

Options for configuring the AssistantsPlanner.

Properties

apiKey

The OpenAI or Azure OpenAI API key. Required.
apiVersion

Optional. Version of the API being called. Default is '2024-02-15-preview'.
assistants_state_variable

Optional. The state variable to use for storing the assistants state.
assistant_id

The ID of the assistant to use. Required.
endpoint

The Azure OpenAI resource endpoint.
polling_interval

Optional. Polling interval in milliseconds.

Property Details

apiKey

The OpenAI or Azure OpenAI API key. Required.

apiKey: string

Property Value

string

apiVersion

Optional. Version of the API being called. Default is '2024-02-15-preview'.

apiVersion?: string

Property Value

string

assistants_state_variable

Optional. The state variable to use for storing the assistants state.

assistants_state_variable?: string

Property Value

string

Remarks

Defaults to 'conversation.assistants_state'.

assistant_id

The ID of the assistant to use. Required.

assistant_id: string

Property Value

string

endpoint

The Azure OpenAI resource endpoint.

endpoint?: string

Property Value

string

Remarks

Required when using Azure OpenAI. Not used for OpenAI.

polling_interval

Optional. Polling interval in milliseconds.

polling_interval?: number

Property Value

number

Remarks

Defaults to 1000 (once a second).