createAction<P>(options): Promise<{ appId: string; appKey: string; appName: string; description: string; display_name: string; enabled: boolean; logo: string; metadata: { name: string; toolName: string; }; name: string; parameters: { description: string; properties: Record<string, any>; required: string[]; title: string; type: string; }; response: Record<string, any>; tags: string[]; }>

Defined in: js/src/sdk/base.toolset.ts:225

Type Parameters

P

P extends Parameters = ZodObject<{}, UnknownKeysParam, ZodTypeAny, {}, {}>

Parameters

options

CreateActionOptions<P>

Returns

Promise<{ appId: string; appKey: string; appName: string; description: string; display_name: string; enabled: boolean; logo: string; metadata: { name: string; toolName: string; }; name: string; parameters: { description: string; properties: Record<string, any>; required: string[]; title: string; type: string; }; response: Record<string, any>; tags: string[]; }>

Inherited from

ComposioToolSet.createAction

executeAction()

executeAction(functionParams): Promise<ActionExecutionResDto>

Defined in: js/src/sdk/base.toolset.ts:241

Parameters

functionParams

ExecuteActionParams

Returns

Promise<ActionExecutionResDto>

Inherited from

ComposioToolSet.executeAction

executeToolCall()

executeToolCall(tool, entityId): Promise<string>

Defined in: js/src/frameworks/openai.ts:77

Parameters

tool

ChatCompletionMessageToolCall

entityId

string = null

Returns

Promise<string>

getActionsSchema()

getActionsSchema(filters, _entityId?): Promise<object[]>

Defined in: js/src/sdk/base.toolset.ts:138

Parameters

filters

actions?

Sequence<string>

_entityId?

string

Returns

Promise<object[]>

Inherited from

ComposioToolSet.getActionsSchema

getEntity()

getEntity(entityId): Promise<Entity>

Defined in: js/src/sdk/base.toolset.ts:237

Parameters

entityId

string

Returns

Promise<Entity>

Inherited from

ComposioToolSet.getEntity

getTools()

getTools(filters, entityId?): Promise<Sequence<ChatCompletionTool>>

Defined in: js/src/frameworks/openai.ts:46

Parameters

filters

actions?

string[] = ...

apps?

string[] = ...

filterByAvailableApps?

boolean = ...

integrationId?

string = ...

tags?

string[] = ...

useCase?

string = ...

useCaseLimit?

number = ...

entityId?

string

Returns

Promise<Sequence<ChatCompletionTool>>

getToolsSchema()

getToolsSchema(filters, _entityId?, _integrationId?): Promise<object[]>

Defined in: js/src/sdk/base.toolset.ts:150

Parameters

filters

actions?

string[] = ...

apps?

string[] = ...

filterByAvailableApps?

boolean = ...

integrationId?

string = ...

tags?

string[] = ...

useCase?

string = ...

useCaseLimit?

number = ...

_entityId?

string

_integrationId?

string

Returns

Promise<object[]>

Inherited from

ComposioToolSet.getToolsSchema

handleAssistantMessage()

handleAssistantMessage(run, entityId): Promise<ToolOutput[]>

Defined in: js/src/frameworks/openai.ts:123

Parameters

run

Run

entityId

string = null

Returns

Promise<ToolOutput[]>

handleToolCall()

handleToolCall(chatCompletion, entityId): Promise<Sequence<string>>

Defined in: js/src/frameworks/openai.ts:103

Parameters

chatCompletion

ChatCompletion

entityId

string = null

Returns

Promise<Sequence<string>>

removePostProcessor()

removePostProcessor(): Promise<void>

Defined in: js/src/sdk/base.toolset.ts:383

Returns

Promise<void>

Inherited from

ComposioToolSet.removePostProcessor

removePreProcessor()

removePreProcessor(): Promise<void>

Defined in: js/src/sdk/base.toolset.ts:379

Returns

Promise<void>

Inherited from

ComposioToolSet.removePreProcessor

removeSchemaProcessor()

removeSchemaProcessor(): Promise<void>

Defined in: js/src/sdk/base.toolset.ts:387

Returns

Promise<void>

Inherited from

ComposioToolSet.removeSchemaProcessor

waitAndHandleAssistantStreamToolCalls()

waitAndHandleAssistantStreamToolCalls(client, runStream, thread, entityId): AsyncGenerator<unknown, void, unknown>

Defined in: js/src/frameworks/openai.ts:158

Parameters

client

OpenAI

runStream

Stream<AssistantStreamEvent>

thread

Thread

entityId

string = null

Returns

AsyncGenerator<unknown, void, unknown>

waitAndHandleAssistantToolCalls()

waitAndHandleAssistantToolCalls(client, run, thread, entityId): Promise<Run>

Defined in: js/src/frameworks/openai.ts:243

Parameters

client

OpenAI

run

Run

thread

Thread

entityId

string = null

Returns

Promise<Run>