Package Exports
- dify-ai-provider
- dify-ai-provider/package.json
Readme
Dify AI Provider for Vercel AI SDK
Note: The current version only supports text messages.
A provider for Dify.AI to work with Vercel AI SDK.
This provider allows you to easily integrate Dify AI's application workflow with your applications using the Vercel AI SDK.
Setting Up with Dify
To use this provider, you'll need:
- Dify Account: Create an account at Dify.AI
- Dify Application: Each application functions as a model within the Vercel AI SDK
- Application ID: Serves as the model ID in your code, can be found in the URL:
https://cloud.dify.ai/app/${dify-application-id}/workflow - API Key: can be obtained from the application settings
- Application ID: Serves as the model ID in your code, can be found in the URL:
Installation
npm install dify-ai-provider
# pnpm
pnpm add dify-ai-provider
# yarn
yarn add dify-ai-providerUsage
Basic Example
import { generateText } from "ai";
import { difyProvider } from "dify-ai-provider";
process.env.DIFY_API_KEY = "dify-api-key"; // app-...
// Create a Dify provider instance
const dify = difyProvider.chat("dify-application-id", {
responseMode: "blocking",
});
// Generate text using Dify AI
const { text, providerMetadata } = await generateText({
model: dify,
messages: [{ role: "user", content: "Hello, how are you today?" }],
headers: { "user-id": "test-user" },
});
const { conversationId, messageId } = providerMetadata.difyWorkflowData;
console.log(text);
console.log("conversationId", conversationId);
console.log("messageId", messageId);Continuing a Conversation
You can continue a conversation by providing a chat-id and user-id in request header:
const { text: followUpText } = await generateText({
model: dify,
messages: [
{ role: "user", content: "That's great! What can you help me with?" },
],
headers: { "user-id": "test-user", "chat-id": conversationId },
});
console.log("followUpText", followUpText);Streaming
import { streamText } from "ai";
import { difyProvider } from "dify-ai-provider";
const dify = difyProvider.chat("dify-application-id");
const stream = streamText({
model: dify,
messages: [{ role: "user", content: "Write a short poem about AI." }],
});
// Process text deltas as they arrive
for await (const chunk of stream.textStream) {
process.stdout.write(chunk);
}Use self-hosted dify
import { createDifyProvider } from "dify-ai-provider";
const difyProvider = createDifyProvider({
baseURL: "your-base-url",
});
const dify = difyProvider.chat("0d8a98af-0207-461d-8c80-5595a9f4aa8c", {
responseMode: "blocking",
apiKey: "your-api-key",
});API Reference
difyProvider.chat(modelId, settings?)
Creates a Dify chat model instance.
Parameters
ProviderSettings
modelId(string): The ID of your Dify application.settings(optional object):baseURL(string): The base URL for the Dify API. Default ishttps://api.dify.ai/v1.headers(Record<string, string>): The headers that will be set to dify api
ChatSettings
inputs(object): Additional inputs to send with the request.responseMode(string): Response mode, defaults to"streaming".apiKey(string): Your Dify application API key. If not provided, it will use theDIFY_API_KEYenvironment variable.