Struct dify_client::client::Client

pub struct Client {
    pub config: Arc<Config>,
    /* private fields */
}

The Client struct represents a client for interacting with the Dify API.

Fields

config: Arc<Config>

The configuration for the client.

Implementations

impl Client

The Client struct represents a client for interacting with the Dify API.

pub fn new(base_url: &str, api_key: &str) -> Self

Creates a new Client instance with the specified base URL and API key.

Arguments

• base_url - The base URL of the Dify API.
• api_key - The API key for authentication.

Returns

A new Client instance.

pub fn new_with_config(c: Config) -> Self

Creates a new Client instance with the specified configuration.

Arguments

• c - The configuration for the client.

Returns

A new Client instance.

pub async fn chat_messages( &self, req_data: ChatMessageRequest ) -> Result<ChatMessageResponse>

Sends a chat message request to the Dify API and returns the response.

Arguments

• req_data - The chat message request data.

Returns

A Result containing the chat message response or an error.

pub async fn chat_messages_stream<F, T>( &self, req_data: ChatMessageRequest, callback: F ) -> Result<Vec<T>>

where F: Fn(ChatMessageSteamEvent) -> Result<Option<T>> + Send + Sync,

Sends a chat message request to the Dify API and returns the response as a stream. The callback function is called for each event in the stream. The callback function should return Some(T) if the event is processed successfully, otherwise None. The function returns a vector of the processed events. The stream is stopped when the callback function returns an error or the stream ends.

Arguments

• req_data - The chat message request data.
• callback - The callback function to process the stream events.

Returns

A Result containing the processed events or an error.

Errors

Returns an error if the request cannot be created or the stream fails.

pub async fn files_upload( &self, req_data: FilesUploadRequest ) -> Result<FilesUploadResponse>

Sends a request to upload files to the Dify API and returns the response.
上传文件（目前仅支持图片）并在发送消息时使用，可实现图文多模态理解。
支持 png, jpg, jpeg, webp, gif 格式。
上传的文件仅供当前终端用户使用。

Arguments

• req_data - The files upload request data.

Returns

A Result containing the files upload response or an error.

pub async fn chat_messages_stop( &self, req_data: ChatMessageStopRequest ) -> Result<ResultResponse>

Sends a request to stop stream chat messages to the Dify API and returns the response.

Arguments

• req_data - The chat message stop request data.

Returns

A Result containing the chat message stop response or an error.

pub async fn messages_suggested( &self, req_data: MessagesSuggestedRequest ) -> Result<MessagesSuggestedResponse>

Sends a request to retrieve suggested messages from the Dify API and returns the response.

Arguments

• req_data - The messages suggested request data.

Returns

A Result containing the messages suggested response or an error.

pub async fn messages_feedbacks( &self, req_data: MessagesFeedbacksRequest ) -> Result<ResultResponse>

Sends a request to retrieve messages feedbacks from the Dify API and returns the response.

Arguments

• req_data - The messages feedbacks request data.

Returns

A Result containing the messages feedbacks response or an error.

pub async fn conversations( &self, req_data: ConversationsRequest ) -> Result<ConversationsResponse>

Sends a request to retrieve conversations from the Dify API and returns the response.

Arguments

• req_data - The conversations request data.

Returns

A Result containing the conversations response or an error.

pub async fn messages( &self, req_data: MessagesRequest ) -> Result<MessagesResponse>

Sends a request to retrieve history messages from the Dify API and returns the response.

Arguments

• req_data - The messages request data.

Returns

A Result containing the messages response or an error.

pub async fn conversations_renaming( &self, req_data: ConversationsRenameRequest ) -> Result<ResultResponse>

Sends a request to rename a conversation in the Dify API and returns the response.

Arguments

• req_data - The conversations rename request data.

Returns

A Result containing the conversations rename response or an error.

pub async fn conversations_delete( &self, req_data: ConversationsDeleteRequest ) -> Result<()>

pub async fn text_to_audio(&self, req_data: TextToAudioRequest) -> Result<Bytes>

Sends a request to convert audio to text in the Dify API and returns the response.

Arguments

• req_data - The audio to text request data.

Returns

A Result containing the audio to text response or an error.

pub async fn audio_to_text( &self, req_data: AudioToTextRequest ) -> Result<AudioToTextResponse>

Sends a request to convert audio to text in the Dify API and returns the response.

Arguments

• req_data - The audio to text request data.

Returns

A Result containing the audio to text response or an error.

pub async fn parameters( &self, req_data: ParametersRequest ) -> Result<ParametersResponse>

Sends a request to retrieve parameters from the Dify API and returns the response.

Arguments

• req_data - The parameters request data.

Returns

A Result containing the parameters response or an error.

pub async fn meta(&self, req_data: MetaRequest) -> Result<MetaResponse>

Sends a request to retrieve meta information from the Dify API and returns the response.

Arguments

• req_data - The meta request data.

Returns

A Result containing the meta response or an error.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.