Share via

PredictedDoCommandAndHandler interface

Package:
@microsoft/teams-ai

Entities argument passed to the action handler for AI.DoCommandActionName.

Extends
PredictedDoCommand

Properties

handler

The handler that should be called to execute the command.

Inherited Properties

action

The named action that the AI system should perform.
actionId

Optional. The id mapped to the name action that the AI system should perform. In OpenAI, this is associated with the action_id tool calls.
parameters

Any parameters that the AI system should use to perform the action.
type

Type to indicate that a DO command is being returned.

Property Details

handler

The handler that should be called to execute the command.

handler: (context: TurnContext, state: TState, parameters?: Record<string, any>, action?: string) => Promise<string>

Property Value

(context: TurnContext, state: TState, parameters?: Record<string, any>, action?: string) => Promise<string>

Inherited Property Details

action

The named action that the AI system should perform.

action: string

Property Value

string

Inherited From PredictedDoCommand.action

actionId

Optional. The id mapped to the name action that the AI system should perform. In OpenAI, this is associated with the action_id tool calls.

actionId?: string

Property Value

string

Inherited From PredictedDoCommand.actionId

parameters

Any parameters that the AI system should use to perform the action.

parameters: Record<string, any>

Property Value

Record<string, any>

Inherited From PredictedDoCommand.parameters

type

Type to indicate that a DO command is being returned.

type: "DO"

Property Value

"DO"

Inherited From PredictedDoCommand.type