1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
use super::{request::*, response::*};
use anyhow::{bail, Result};
use eventsource_stream::Eventsource;
use futures::stream::StreamExt;
use reqwest::{
header::{HeaderMap, HeaderValue, CACHE_CONTROL, CONTENT_TYPE},
multipart, Method, Request,
};
use serde::Serialize;
use std::fmt::{Display, Formatter, Result as FmtResult};
use std::sync::Arc;
use std::time::Duration;
/// API 路径
#[derive(Debug)]
pub enum ApiPath {
/// 发送对话消息, 创建会话消息。
ChatMessages,
/// 上传文件
/// 上传文件(目前仅支持图片)并在发送消息时使用,可实现图文多模态理解。
/// 支持 png, jpg, jpeg, webp, gif 格式。
/// 上传的文件仅供当前终端用户使用。
FilesUpload,
/// 停止响应, 仅支持流式模式。
ChatMessagesStop,
/// 消息反馈(点赞, 消息终端用户反馈、点赞,方便应用开发者优化输出预期。
MessagesFeedbacks,
/// 获取下一轮建议问题列表
MessagesSuggested,
/// 获取会话历史消息, 滚动加载形式返回历史聊天记录,第一页返回最新 limit 条,即:倒序返回。
Messages,
/// 获取会话列表, 获取当前用户的会话列表,默认返回最近的 20 条。
Conversations,
/// 删除会话
ConversationsDelete,
/// 会话重命名, 对会话进行重命名,会话名称用于显示在支持多会话的客户端上。
ConversationsRename,
/// 语音转文字
AudioToText,
/// 文字转语音
TextToAudio,
/// 获取应用配置信息, 用于进入页面一开始,获取功能开关、输入参数名称、类型及默认值等使用。
Parameters,
/// 获取应用Meta信息, 用于获取工具icon
Meta,
/// workflow
/// 执行 workflow
WorkflowsRun,
/// 停止响应, 仅支持流式模式。
WorkflowsStop,
/// completion 文本生成
/// 发送请求给文本生成型应用
CompletionMessages,
/// 文本生成停止响应
CompletionMessagesStop,
}
/// API 路径
impl ApiPath {
/// 获取 API 路径
/// # Example
/// ```rust
/// use dify_client::ApiPath;
/// let path = ApiPath::ChatMessages;
/// assert_eq!(path.as_str(), "/v1/chat-messages");
/// ```
pub fn as_str(&self) -> &'static str {
match self {
ApiPath::ChatMessages => "/v1/chat-messages",
ApiPath::FilesUpload => "/v1/files/upload",
ApiPath::ChatMessagesStop => "/v1/chat-messages/{task_id}/stop",
ApiPath::MessagesFeedbacks => "/v1/messages/{message_id}/feedbacks",
ApiPath::MessagesSuggested => "/v1/messages/{message_id}/suggested",
ApiPath::Messages => "/v1/messages",
ApiPath::Conversations => "/v1/conversations",
ApiPath::ConversationsDelete => "/v1/conversations/{conversation_id}",
ApiPath::ConversationsRename => "/v1/conversations/{conversation_id}/name",
ApiPath::AudioToText => "/v1/audio-to-text",
ApiPath::TextToAudio => "/v1/text-to-audio",
ApiPath::Parameters => "/v1/parameters",
ApiPath::Meta => "/v1/meta",
ApiPath::WorkflowsRun => "/v1/workflows/run",
ApiPath::WorkflowsStop => "/v1/workflows/{task_id}/stop",
ApiPath::CompletionMessages => "/v1/completion-messages",
ApiPath::CompletionMessagesStop => "/v1/completion-messages/{task_id}/stop",
}
}
}
impl Display for ApiPath {
fn fmt(&self, f: &mut Formatter) -> FmtResult {
write!(f, "{}", self.as_str())
}
}
#[derive(Clone, Debug)]
/// The configuration for the Dify client.
pub struct Config {
/// The base URL of the Dify API.
pub base_url: String,
/// The API key for the Dify API.
pub api_key: String,
/// The timeout for the client requests.
pub timeout: Duration,
}
/// Implements the default configuration for the client.
impl Default for Config {
/// Returns a new instance of `ClientConfig` with default values.
fn default() -> Self {
Self {
base_url: "https://api.dify.ai".into(),
api_key: "API_KEY".into(),
timeout: Duration::from_secs(30),
}
}
}
/// The `Client` struct represents a client for interacting with the Dify API.
#[derive(Clone, Debug)]
pub struct Client {
/// The configuration for the client.
pub config: Arc<Config>,
/// The HTTP client for sending requests.
pub(crate) http_client: reqwest::Client,
}
/// The `Client` struct represents a client for interacting with the Dify API.
impl Client {
/// 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(base_url: &str, api_key: &str) -> Self {
Self::new_with_config(Config {
base_url: base_url.into(),
api_key: api_key.into(),
..Config::default()
})
}
/// Creates a new `Client` instance with the specified configuration.
///
/// # Arguments
/// * `c` - The configuration for the client.
///
/// # Returns
/// A new `Client` instance.
pub fn new_with_config(c: Config) -> Self {
let mut client = reqwest::ClientBuilder::new();
if !c.timeout.is_zero() {
client = client.timeout(c.timeout);
}
let http_client = client.build().expect("Failed to create http client");
Self {
config: Arc::new(c),
http_client,
}
}
/// Builds the API request URL.
///
/// # Arguments
/// * `api_path` - The API path.
///
/// # Returns
/// The request URL.
fn build_request_api(&self, api_path: ApiPath) -> String {
self.config.base_url.trim_end_matches("/").to_string() + api_path.as_str()
}
/// Sets the headers for a request with JSON content type.
///
/// # Arguments
/// * `headers` - The headers to set.
///
/// # Returns
/// A `Result` containing the request or an error.
///
/// # Errors
/// Returns an error if the headers cannot be set.
fn set_headers_json(&self, headers: &mut HeaderMap) {
headers.insert(CACHE_CONTROL, HeaderValue::from_static("no-cache"));
headers.insert(
CONTENT_TYPE,
HeaderValue::from_static("application/json; charset=utf-8"),
);
}
/// Sets the headers for a request with bearer authentication.
///
/// # Arguments
/// * `headers` - The headers to set.
///
/// # Returns
/// A `Result` containing the request or an error.
///
/// # Errors
/// Returns an error if the headers cannot be set.
///
/// # Panics
/// Panics if the API key is not set.
fn set_headers_bearer_auth(&self, headers: &mut HeaderMap) {
headers.insert(
reqwest::header::AUTHORIZATION,
HeaderValue::from_str(&format!("Bearer {}", self.config.api_key)).unwrap(),
);
}
/// Creates a request with the specified URL, method, and data.
///
/// # Arguments
/// * `url` - The URL for the request.
/// * `method` - The HTTP method for the request.
/// * `data` - The data for the request.
///
/// # Returns
/// A `Result` containing the request or an error.
///
/// # Errors
/// Returns an error if the request cannot be created.
///
/// # Panics
/// Panics if the method is not supported.
fn create_request(&self, url: String, method: Method, data: impl Serialize) -> Result<Request> {
let mut headers = HeaderMap::new();
self.set_headers_json(&mut headers);
self.set_headers_bearer_auth(&mut headers);
match method {
Method::POST => {
let r = self
.http_client
.post(url)
.headers(headers)
.json(&data)
.build()?;
Ok(r)
}
Method::GET => {
let r = self
.http_client
.get(url)
.headers(headers)
.query(&data)
.build()?;
Ok(r)
}
Method::DELETE => {
let r = self
.http_client
.delete(url)
.headers(headers)
.json(&data)
.build()?;
Ok(r)
}
_ => {
bail!("Method not supported");
}
}
}
/// Creates a form request with the specified URL and data.
///
/// # Arguments
/// * `url` - The URL for the request.
/// * `data` - The data for the request.
///
/// # Returns
/// A `Result` containing the request or an error.
fn create_multipart_request(&self, url: String, form_data: multipart::Form) -> Result<Request> {
let mut headers = HeaderMap::new();
self.set_headers_json(&mut headers);
self.set_headers_bearer_auth(&mut headers);
let r = self
.http_client
.post(url)
.headers(headers)
.multipart(form_data)
.build()?;
Ok(r)
}
/// Creates a chat message request.
///
/// # Arguments
/// * `req` - The chat message request data.
///
/// # Returns
/// A `Result` containing the request or an error.
///
/// # Errors
/// Returns an error if the request cannot be created.
fn create_chat_message_request(&self, req: ChatMessageRequest) -> Result<Request> {
let url = self.build_request_api(ApiPath::ChatMessages);
self.create_request(url, Method::POST, req)
}
/// 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(
&self,
mut req_data: ChatMessageRequest,
) -> Result<ChatMessageResponse> {
req_data.response_mode = ResponseMode::Blocking;
let req = self.create_chat_message_request(req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<ChatMessageResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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 chat_messages_stream<F, T>(
&self,
mut req_data: ChatMessageRequest,
callback: F,
) -> Result<Vec<T>>
where
F: Fn(SteamMessageEvent) -> Result<Option<T>> + Send + Sync,
{
req_data.response_mode = ResponseMode::Streaming;
let req = self.create_chat_message_request(req_data)?;
let resp = self.http_client.execute(req).await?;
let mut stream = resp.bytes_stream().eventsource();
let mut ret: Vec<T> = Vec::new();
while let Some(event) = stream.next().await {
let event = event?;
if event.event == "message" {
match serde_json::from_str::<SteamMessageEvent>(&event.data) {
Ok(msg_event) => {
if let Some(answer) = callback(msg_event)? {
ret.push(answer);
}
}
Err(e) => bail!("data: {}, error: {}", event.data, e),
};
}
}
Ok(ret)
}
/// 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 files_upload(&self, req_data: FilesUploadRequest) -> Result<FilesUploadResponse> {
if !infer::is_image(&req_data.file) {
bail!("FilesUploadRequest.File Illegal");
}
let kind = infer::get(&req_data.file).expect("Failed to get file type");
let file_part = multipart::Part::stream(req_data.file)
.file_name(format!("image_file.{}", kind.extension()))
.mime_str(kind.mime_type())?;
let form = multipart::Form::new()
.text("user", req_data.user)
.part("file", file_part);
let url = self.build_request_api(ApiPath::FilesUpload);
let req = self.create_multipart_request(url, form)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<FilesUploadResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// Sends a request to stop stream task from the Dify API and returns the response.
/// 仅支持流式模式。
///
/// # Arguments
/// * `req_data` - The stream task stop request data.
/// * `api_path` - The API path.
///
/// # Returns
/// A `Result` containing the stream task stop response or an error.
async fn stream_task_stop(
&self,
mut req_data: StreamTaskStopRequest,
api_path: ApiPath,
) -> Result<ResultResponse> {
if req_data.task_id.is_empty() {
bail!("StreamTaskStopRequest.TaskId Illegal");
}
let url = self.build_request_api(api_path);
let url = url.replace("{task_id}", &req_data.task_id);
req_data.task_id = String::new();
let req = self.create_request(url, Method::POST, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<ResultResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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 chat_messages_stop(
&self,
req_data: StreamTaskStopRequest,
) -> Result<ResultResponse> {
self.stream_task_stop(req_data, ApiPath::ChatMessagesStop)
.await
}
/// 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_suggested(
&self,
mut req_data: MessagesSuggestedRequest,
) -> Result<MessagesSuggestedResponse> {
if req_data.message_id.is_empty() {
bail!("MessagesSuggestedRequest.MessageID Illegal");
}
let url = self.build_request_api(ApiPath::MessagesSuggested);
let url = url.replace("{message_id}", &req_data.message_id);
req_data.message_id = String::new();
let req = self.create_request(url, Method::GET, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<MessagesSuggestedResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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 messages_feedbacks(
&self,
mut req_data: MessagesFeedbacksRequest,
) -> Result<ResultResponse> {
if req_data.message_id.is_empty() {
bail!("MessagesFeedbacksRequest.MessageID Illegal");
}
let url = self.build_request_api(ApiPath::MessagesFeedbacks);
let url = url.replace("{message_id}", &req_data.message_id);
req_data.message_id = String::new();
let req = self.create_request(url, Method::POST, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<ResultResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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 conversations(
&self,
req_data: ConversationsRequest,
) -> Result<ConversationsResponse> {
if req_data.user.is_empty() {
bail!("ConversationsRequest.User Illegal");
}
let url = self.build_request_api(ApiPath::Conversations);
let req = self.create_request(url, Method::GET, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<ConversationsResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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 messages(&self, req_data: MessagesRequest) -> Result<MessagesResponse> {
if req_data.conversation_id.is_empty() {
bail!("MessagesRequest.ConversationID Illegal");
}
let url = self.build_request_api(ApiPath::Messages);
let req = self.create_request(url, Method::GET, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<MessagesResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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_renaming(
&self,
mut req_data: ConversationsRenameRequest,
) -> Result<ResultResponse> {
if req_data.conversation_id.is_empty() {
bail!("ConversationsRenameRequest.ConversationID Illegal");
}
if req_data.auto_generate && req_data.name.is_none() {
bail!("ConversationsRenameRequest.Name Illegal");
}
let url = self.build_request_api(ApiPath::ConversationsRename);
let url = url.replace("{conversation_id}", &req_data.conversation_id);
req_data.conversation_id = String::new();
let req = self.create_request(url, Method::POST, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<ResultResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// Sends a request to delete a conversation in the Dify API and returns the response.
///
/// # Arguments
/// * `req_data` - The conversations delete request data.
///
/// # Returns
/// A `Result` containing the conversations delete response or an error.
pub async fn conversations_delete(
&self,
mut req_data: ConversationsDeleteRequest,
) -> Result<()> {
if req_data.conversation_id.is_empty() {
bail!("ConversationsDeleteRequest.ConversationID Illegal");
}
let url = self.build_request_api(ApiPath::ConversationsDelete);
let url = url.replace("{conversation_id}", &req_data.conversation_id);
req_data.conversation_id = String::new();
let req = self.create_request(url, Method::DELETE, req_data)?;
let resp = self.http_client.execute(req).await?;
// http 204 means success ?
if resp.status().as_u16() == 204 {
Ok(())
} else {
// parse message type
let text = resp.text().await?;
if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
}
/// 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 text_to_audio(&self, req_data: TextToAudioRequest) -> Result<Bytes> {
if req_data.text.is_empty() {
bail!("TextToAudioRequest.Text Illegal");
}
let url = self.build_request_api(ApiPath::TextToAudio);
let req = self.create_request(url, Method::POST, req_data)?;
let resp = self.http_client.execute(req).await?;
// check if header is audio
let content_type = resp.headers().get(CONTENT_TYPE);
let content_type = content_type
.ok_or(anyhow::anyhow!("Content-Type is missing"))?
.to_str()?;
// check if content_type is audio
if content_type.starts_with("audio/") {
let bytes = resp.bytes().await?;
return Ok(bytes);
}
let text = resp.text().await?;
if text.is_empty() {
bail!("Content-Type is not audio/wav");
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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> {
if !infer::is_audio(&req_data.file) {
bail!("AudioToTextRequest.File Illegal");
}
let kind = infer::get(&req_data.file).expect("Failed to get file type");
let file_part = multipart::Part::stream(req_data.file)
.file_name(format!("audio_file.{}", kind.extension()))
.mime_str(kind.mime_type())?;
let form = multipart::Form::new()
.text("user", req_data.user)
.part("file", file_part);
let url = self.build_request_api(ApiPath::AudioToText);
let req = self.create_multipart_request(url, form)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<AudioToTextResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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 parameters(&self, req_data: ParametersRequest) -> Result<ParametersResponse> {
if req_data.user.is_empty() {
bail!("ParametersRequest.User Illegal");
}
let url = self.build_request_api(ApiPath::Parameters);
let req = self.create_request(url, Method::GET, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<ParametersResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// 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.
pub async fn meta(&self, req_data: MetaRequest) -> Result<MetaResponse> {
if req_data.user.is_empty() {
bail!("MetaRequest.User Illegal");
}
let url = self.build_request_api(ApiPath::Meta);
let req = self.create_request(url, Method::GET, req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<MetaResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// Creates a request to run workflows from the Dify API.
///
/// # Arguments
/// * `req` - The workflows run request data.
///
/// # Returns
/// A `Result` containing the request or an error.
fn create_workflows_run_request(&self, req: WorkflowsRunRequest) -> Result<Request> {
let url = self.build_request_api(ApiPath::WorkflowsRun);
self.create_request(url, Method::POST, req)
}
/// Sends a request to run workflows from the Dify API and returns the response.
///
/// # Arguments
/// * `req_data` - The workflows run request data.
///
/// # Returns
/// A `Result` containing the workflows run response or an error.
pub async fn workflows_run(
&self,
mut req_data: WorkflowsRunRequest,
) -> Result<WorkflowsRunResponse> {
req_data.response_mode = ResponseMode::Blocking;
let req = self.create_workflows_run_request(req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<WorkflowsRunResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// Sends a request to run workflows from 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 workflows run 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 workflows_run_stream<F, T>(
&self,
mut req_data: WorkflowsRunRequest,
callback: F,
) -> Result<Vec<T>>
where
F: Fn(SteamMessageEvent) -> Result<Option<T>> + Send + Sync,
{
req_data.response_mode = ResponseMode::Streaming;
let req = self.create_workflows_run_request(req_data)?;
let resp = self.http_client.execute(req).await?;
let mut stream = resp.bytes_stream().eventsource();
let mut ret: Vec<T> = Vec::new();
while let Some(event) = stream.next().await {
let event = event?;
if event.event == "message" {
match serde_json::from_str::<SteamMessageEvent>(&event.data) {
Ok(msg_event) => {
if let Some(answer) = callback(msg_event)? {
ret.push(answer);
}
}
Err(e) => bail!("data: {}, error: {}", event.data, e),
};
}
}
Ok(ret)
}
/// Sends a request to stop stream workflows from the Dify API and returns the response.
///
/// # Arguments
/// * `req_data` - The stream task stop request data.
///
/// # Returns
/// A `Result` containing the stream task stop response or an error.
pub async fn workflows_stop(&self, req_data: StreamTaskStopRequest) -> Result<ResultResponse> {
self.stream_task_stop(req_data, ApiPath::WorkflowsStop)
.await
}
/// Creates a request to create completion messages from the Dify API.
///
/// # Arguments
/// * `req` - The completion messages request data.
///
/// # Returns
/// A `Result` containing the request or an error.
fn create_completion_messages_request(
&self,
req: CompletionMessagesRequest,
) -> Result<Request> {
let url = self.build_request_api(ApiPath::CompletionMessages);
self.create_request(url, Method::POST, req)
}
/// Sends a request to create completion messages from the Dify API and returns the response.
/// 发送请求给文本生成型应用
///
/// # Arguments
/// * `req_data` - The completion messages request data.
///
/// # Returns
/// A `Result` containing the completion messages response or an error.
pub async fn completion_messages(
&self,
mut req_data: CompletionMessagesRequest,
) -> Result<CompletionMessagesResponse> {
req_data.response_mode = ResponseMode::Blocking;
let req = self.create_completion_messages_request(req_data)?;
let resp = self.http_client.execute(req).await?;
let text = resp.text().await?;
// parse message type
if let Ok(data) = serde_json::from_str::<CompletionMessagesResponse>(&text) {
Ok(data)
} else if let Ok(err) = serde_json::from_str::<ErrorResponse>(&text) {
bail!(err)
} else {
bail!(text)
}
}
/// Sends a request to create completion messages from 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 completion messages 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 completion_messages_stream<F, T>(
&self,
mut req_data: CompletionMessagesRequest,
callback: F,
) -> Result<Vec<T>>
where
F: Fn(SteamMessageEvent) -> Result<Option<T>> + Send + Sync,
{
req_data.response_mode = ResponseMode::Streaming;
let req = self.create_completion_messages_request(req_data)?;
let resp = self.http_client.execute(req).await?;
let mut stream = resp.bytes_stream().eventsource();
let mut ret: Vec<T> = Vec::new();
while let Some(event) = stream.next().await {
let event = event?;
if event.event == "message" {
match serde_json::from_str::<SteamMessageEvent>(&event.data) {
Ok(msg_event) => {
if let Some(answer) = callback(msg_event)? {
ret.push(answer);
}
}
Err(e) => bail!("data: {}, error: {}", event.data, e),
};
}
}
Ok(ret)
}
/// Sends a request to stop stream completion messages from the Dify API and returns the response.
/// 文本生成停止响应
///
/// # Arguments
/// * `req_data` - The stream task stop request data.
///
/// # Returns
/// A `Result` containing the stream task stop response or an error.
pub async fn completion_messages_stop(
&self,
req_data: StreamTaskStopRequest,
) -> Result<ResultResponse> {
self.stream_task_stop(req_data, ApiPath::CompletionMessagesStop)
.await
}
}