dify-client-plus-plus/index.d.ts

This is the Node.js SDK for the Dify.AI API, which allows you to easily integrate Dify.AI into your Node.js applications.

// Types.d.ts
export const BASE_URL: string;

export type RequestMethods = 'GET' | 'POST' | 'PATCH' | 'DELETE';

interface Params {
  [key: string]: any;
}

interface HeaderParams {
  [key: string]: string;
}

interface User {
}

export declare class DifyClient {
  constructor(apiKey: string, baseUrl?: string);

  updateApiKey(apiKey: string): void;

  sendRequest(
    method: RequestMethods,
    endpoint: string,
    data?: any,
    params?: Params,
    stream?: boolean,
    headerParams?: HeaderParams
  ): Promise<any>;

  messageFeedback(message_id: string, rating: number, user: User): Promise<any>;

  getApplicationParameters(user: User): Promise<any>;
  getMeta(user: User): Promise<any>;
  getInfo(user: User): Promise<any>;
  fileUpload(data: FormData): Promise<any>;
  aduioToText(data: FormData): Promise<any>;
  textToAudio(data: FormData): Promise<any>;
}

export declare class CompletionClient extends DifyClient {
  checkWorkflowStatus(workflow_id: string, user: User): Promise<any>;
  createCompletionMessage(
    inputs: any,
    user: User,
    stream?: boolean,
    files?: File[] | null
  ): Promise<any>;
}

export declare class ChatClient extends DifyClient {
  createChatMessage(
    inputs: any,
    query: string,
    user: User,
    stream?: boolean,
    conversation_id?: string | null,
    files?: File[] | null
  ): Promise<any>;

  getConversationMessages(
    user: User,
    conversation_id?: string,
    first_id?: string | null,
    limit?: number | null
  ): Promise<any>;

  getConversations(user: User, first_id?: string | null, limit?: number | null, pinned?: boolean | null): Promise<any>;

  renameConversation(conversation_id: string, name: string, user: User, auto_generate: boolean): Promise<any>;
  deleteConversation(conversation_id: string, user: User): Promise<any>;
  getSuggested(message_id_id: string, user: User): Promise<any>;

  stopChat(task_id: string, user: User): Promise<any>;
}