Dapr Conversation JavaScript SDK on Dapr Docs

How to: Converse with an LLM using the Dapr JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use client.conversation.converse(request) to send role-based messages to a configured conversation component. You do not need a DaprServer or a provider-specific JavaScript SDK.

Prerequisites

Dapr CLI
An initialized Dapr environment with Dapr runtime 1.16 or later
Node.js 18 or later
The @dapr/dapr package, version 3.19.0 or later

Installation

In your application directory, initialize an npm project if you do not already have one, then install the SDK:

npm init -y
npm install @dapr/dapr@3.19.0

The examples use JavaScript ES modules and run as .mjs files without a TypeScript compiler. The same APIs are available in TypeScript, with request and response types exported from @dapr/dapr.

Dapr Conversation JavaScript client usage

Mon, 01 Jan 0001 00:00:00 +0000

DaprClient.conversation exposes one asynchronous method:

converse(request: ConversationRequestAlpha2): Promise<ConversationResponseAlpha2>;

Import these types, and the other Conversation* types used below, from @dapr/dapr. This guidance targets 3.19.0 or later.

Runtime and provider support

Capability	Minimum Dapr runtime
Alpha2 messages, tool calling, temperature, and PII scrubbing	1.16
`responseFormat`, `promptCacheRetention`, and token usage statistics	1.17
Model name in the response	1.18
`maxTokens`	1.19

Availability also depends on the conversation component and model. An SDK option does not make an unsupported provider feature available. See the Conversation API reference and your component reference.

How to: Call tools with the Dapr Conversation JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Tool calling lets a model request an application-defined function. Dapr and the JavaScript SDK transport tool definitions and calls; your application validates arguments, authorizes and executes the function, and sends the result back.

Prerequisites

Complete the conversation setup guide using @dapr/dapr 3.19.0 or later, Dapr runtime 1.16 or later, and a component/model that supports tool calling. The echo component is not sufficient.

Define a tool and handle its result

The following example uses the llm component configured in the setup guide. Save it as tools.mjs and run it with the same dapr run command, replacing app.mjs with tools.mjs.