@ifzai/connect2dify
Version:
A comprehensive TypeScript client for the Dify API, providing a clean and modular interface for chat, workflow, file management, and application interactions.
47 lines (46 loc) • 1.86 kB
TypeScript
/**
* Chat-related API methods for Dify client
*/
import type { ChatChunkCompletionResponse, ChatCompletionResponse, CreateMessageFeedbackParams, CreateMessageFeedbackResult, DifyConfiguration, GetMessageSuggestsParams, GetMessageSuggestsResult, GetMessagesParams, GetMessagesResponse, SendMessageParams, StopMessageResponseParams, StopMessageResponseResult } from './types.js';
/**
* Chat API methods
*/
export declare class ChatAPI {
private config;
constructor(config: DifyConfiguration);
/**
* Send a chat message to the Dify application
* @param params - Message parameters
* @returns Promise resolving to chat completion response or stream chunks
*/
sendMessage(params: SendMessageParams): Promise<ChatCompletionResponse | ChatChunkCompletionResponse[]>;
/**
* Get messages from a conversation
* @param params - Query parameters
* @returns Promise resolving to messages response
*/
getMessages(params: GetMessagesParams): Promise<GetMessagesResponse>;
/**
* Create feedback for a message
* @param params - Feedback parameters
* @returns Promise resolving to feedback result
*/
createMessageFeedback(params: CreateMessageFeedbackParams): Promise<CreateMessageFeedbackResult>;
/**
* Get suggested questions for a message
* @param params - Query parameters
* @returns Promise resolving to suggested questions
*/
getMessageSuggests(params: GetMessageSuggestsParams): Promise<GetMessageSuggestsResult>;
/**
* Stop a message response
* @param params - Stop parameters
* @returns Promise resolving to stop result
*/
stopMessageResponse(params: StopMessageResponseParams): Promise<StopMessageResponseResult>;
/**
* Handle streaming chat responses
* @private
*/
private handleChatStream;
}