dify-client 0.3.1

A client for the Dify API
Documentation
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
use anyhow::Result;
use dify_client::{http::header, request, response, Client, Config};
use futures::StreamExt;
use std::{collections::HashMap, env, time::Duration};

#[test]
fn test_config() {
    let config = Config {
        base_url: "https://api.dify.ai".into(),
        api_key: "API_KEY".into(),
        timeout: Duration::from_secs(30),
    };
    assert_eq!(config.base_url, "https://api.dify.ai");
    assert_eq!(config.api_key, "API_KEY");
    assert_eq!(config.timeout, Duration::from_secs(30));
}

#[test]
fn test_new_client() {
    let client = Client::new("https://api.dify.ai".into(), "API_KEY".into());
    assert_eq!(client.config.base_url, "https://api.dify.ai");
    assert_eq!(client.config.api_key, "API_KEY");
    assert_eq!(client.config.timeout, Duration::from_secs(30));
}

#[test]
fn test_new_client_with_config() {
    let config = Config {
        base_url: "https://api.dify.ai".into(),
        api_key: "API_KEY".into(),
        timeout: Duration::from_secs(60),
    };
    let client = Client::new_with_config(config);
    assert_eq!(client.config.base_url, "https://api.dify.ai");
    assert_eq!(client.config.api_key, "API_KEY");
    assert_eq!(client.config.timeout, Duration::from_secs(60));
}

fn get_client(api_key: Option<&str>) -> Client {
    let dify_base_url = env::var("DIFY_BASE_URL").expect("DIFY_BASE_URL is not set");
    let dify_api_key = env::var("DIFY_API_KEY").expect("DIFY_API_KEY is not set");
    let dify_api_key = api_key.unwrap_or(dify_api_key.as_str());
    Client::new_with_config(Config {
        base_url: dify_base_url,
        api_key: dify_api_key.to_owned(),
        timeout: Duration::from_secs(60),
    })
}

fn get_client_default() -> Client {
    get_client(None)
}

#[tokio::test]
async fn test_chat_message_complex() {
    let client = get_client_default();
    let msg = request::ChatMessagesRequest {
        inputs: HashMap::from([("name".into(), "iPhone 13 Pro Max".into())]),
        query: "What are the specs of the iPhone 13 Pro Max?".into(),
        response_mode: request::ResponseMode::Blocking,
        conversation_id: "".into(),
        user: "afa".into(),
        files: vec![request::FileInput::RemoteUrl {
            url: "https://www.baidu.com/img/PCfb_5bf082d29588c07f842ccde3f97243ea.png".into(),
            type_: request::FileType::Image,
        }],
        auto_generate_name: true,
    };
    let result = client.api().chat_messages(msg).await;
    assert_chat_message_result(result);
}

#[tokio::test]
async fn test_chat_message_simple() {
    let client = get_client_default();
    let msg = request::ChatMessagesRequest {
        query: "how are you?".into(),
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().chat_messages(msg).await;
    assert_chat_message_result(result);
}

#[tokio::test]
async fn test_chat_message_stream() {
    let client = get_client_default();
    let msg = request::ChatMessagesRequest {
        query: "write a story in 100 words about life".into(),
        user: "afa".into(),
        ..Default::default()
    };

    let mut stream = client
        .api()
        .chat_messages_stream(msg)
        .await
        .expect("stream completion messages failed");

    let mut outputs = Vec::new();
    while let Some(event) = stream.next().await {
        let event = event.expect("stream mssage event failed");
        match event {
            response::SseMessageEvent::Message { answer, .. } => {
                println!("answer: {:?}", answer);
                outputs.push(answer);
            }
            response::SseMessageEvent::Error { message, .. } => {
                eprint!("error event: {}", message)
            }
            _ => {
                let event_name = serde_json::json!(event)
                    .get("event")
                    .map(|v| v.to_string())
                    .unwrap_or("unknown".into());
                println!(
                    "debug: skip dify message event: {}",
                    event_name.trim_matches('"')
                );
            }
        }
    }

    let outputs = outputs.concat();
    println!("outputs: {}", outputs);
}

#[tokio::test]
async fn test_chat_message_stream_agent() {
    let client = get_client(Some("app-iTiQkNf5LUbMq0mG0QdxXTob"));
    let msg = request::ChatMessagesRequest {
        query: "write a story in 100 words about life".into(),
        user: "afa".into(),
        ..Default::default()
    };

    let mut stream = client
        .api()
        .chat_messages_stream(msg)
        .await
        .expect("stream agent chat messages failed");

    let mut outputs = Vec::new();
    while let Some(event) = stream.next().await {
        let event = event.expect("stream mssage event failed");
        match event {
            response::SseMessageEvent::AgentMessage { answer, .. } => {
                println!("answer: {:?}", answer);
                outputs.push(answer);
            }
            response::SseMessageEvent::Error { message, .. } => {
                eprint!("error event: {}", message)
            }
            _ => {
                let event_name = serde_json::json!(event)
                    .get("event")
                    .map(|v| v.to_string())
                    .unwrap_or("unknown".into());
                println!(
                    "debug: skip dify message event: {}",
                    event_name.trim_matches('"')
                );
            }
        }
    }

    let outputs = outputs.concat();
    println!("outputs: {}", outputs);
}

fn assert_chat_message_result(result: Result<response::ChatMessagesResponse>) {
    if let Err(e) = result {
        match e.downcast::<response::ErrorResponse>() {
            Ok(err_resp) => {
                assert!(!err_resp.message.is_empty());
            }
            Err(e_self) => {
                assert!(!e_self.to_string().is_empty());
            }
        };
    } else {
        let response = result.unwrap();
        println!("{:}", serde_json::to_string_pretty(&response).unwrap());
        assert_eq!(response.event, "message");
        assert_eq!(response.mode, response::AppMode::AdvancedChat);
        assert!(!response.base.message_id.is_empty());
        assert!(response.base.conversation_id.is_some());
    }
}

#[tokio::test]
async fn test_feedback_message() {
    let client = get_client_default();
    let msg = request::MessagesFeedbacksRequest {
        message_id: "e754aaf1-d2a3-426a-a9cc-39c508ccfe86".into(),
        rating: Some(request::Feedback::Like),
        user: "afa".into(),
    };
    let result = client.api().messages_feedbacks(msg).await;
    assert_feedback_result(result);

    let msg1 = request::MessagesFeedbacksRequest {
        message_id: "e754aaf1-d2a3-426a-a9cc-39c508ccfe86".into(),
        rating: None,
        user: "afa".into(),
    };
    let result1 = client.api().messages_feedbacks(msg1).await;
    assert_feedback_result(result1);

    let msg2 = request::MessagesFeedbacksRequest {
        message_id: "e754aaf1-d2a3-426a-a9cc-39c508ccfe86".into(),
        rating: Some(request::Feedback::Dislike),
        user: "afa".into(),
    };
    let result2 = client.api().messages_feedbacks(msg2).await;
    assert_feedback_result(result2);
}

fn assert_feedback_result(result: Result<response::ResultResponse>) {
    if let Err(e) = result {
        match e.downcast::<response::ErrorResponse>() {
            Ok(err_resp) => {
                assert!(!err_resp.message.is_empty());
            }
            Err(e_self) => {
                assert!(!e_self.to_string().is_empty());
            }
        };
    } else {
        let response = result.unwrap();
        assert_eq!(response.result, "success");
    }
}

#[tokio::test]
async fn test_conversations_get() {
    let client = get_client_default();
    let msg = request::ConversationsRequest {
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().conversations(msg).await;
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
    assert!(response.data.len() > 0);
}

#[tokio::test]
async fn test_messages_get() {
    let client = get_client_default();
    let msg = request::MessagesRequest {
        conversation_id: "45000310-eb4a-480b-ba90-3f658e87bc6a".into(),
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().messages(msg).await;
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
    assert!(response.data.len() > 0);
}

#[tokio::test]
async fn test_parameters() {
    let client = get_client_default();
    let msg = request::ParametersRequest { user: "afa".into() };
    let result = client.api().parameters(msg).await;
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
    assert!(response.system_parameters.image_file_size_limit.len() > 0);
}

#[tokio::test]
async fn test_chat_messages_stop() {
    let client = get_client_default();
    let msg = request::StreamTaskStopRequest {
        task_id: "task_id".into(),
        user: "afa".into(),
    };
    let result = client.api().chat_messages_stop(msg).await;
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_messages_suggested() {
    let client = get_client(Some("app-Dj4rqEJ0QZh2beEAjIfsJGbm"));
    // send a message to get message_id
    let msg = request::ChatMessagesRequest {
        query: "how are you?".into(),
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().chat_messages(msg).await;
    let message_id = result.unwrap().base.message_id;
    // get suggested messages
    let msg = request::MessagesSuggestedRequest { message_id };
    let result = client.api().messages_suggested(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_conversations_delete() {
    let client = get_client_default();
    let msg = request::ConversationsDeleteRequest {
        conversation_id: "40d530ea-f743-4c7a-9639-bbdae4ef6e6d".into(),
        user: "afa".into(),
    };
    let result = client.api().conversations_delete(msg).await;
    println!("{:?}", result);
    // assert!(result.is_ok());
    // let response = result.unwrap();
    // println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_meta() {
    let client = get_client(Some("app-iTiQkNf5LUbMq0mG0QdxXTob"));
    let msg = request::MetaRequest { user: "afa".into() };
    let result = client.api().meta(msg).await;
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_text_to_audio() {
    let client = get_client_default();
    let msg = request::TextToAudioRequest {
        text: "Hello, dify client!".into(),
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().text_to_audio(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
    let bytes = result.unwrap();
    // write bytes to /tmp/test.mp3
    std::fs::write("/tmp/test.mp3", bytes).expect("write file failed");
}

#[tokio::test]
async fn test_audio_to_text() {
    let client = get_client_default();
    let vec_u8 = std::fs::read("/tmp/test.mp3").expect("read file failed");

    let msg = request::AudioToTextRequest {
        file: vec_u8.into(),
        user: "afa".into(),
    };
    let result = client.api().audio_to_text(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
}

#[tokio::test]
async fn test_files_upload() {
    let client = get_client_default();
    let vec_u8 = std::fs::read("/tmp/test.png").expect("read file failed");

    let msg = request::FilesUploadRequest {
        file: vec_u8.into(),
        user: "afa".into(),
    };
    let result = client.api().files_upload(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
}

#[tokio::test]
async fn test_workflows_run() {
    let client = get_client(Some("app-hxBGNNbzVsl46o20NPvSYOxB"));
    let s = r#"Hi, Gu from Dify here. I couldn't be more excited to share with you our latest feature: Workflow.
We've all seen the huge potential of LLMs in the past year. But as many of you have experienced firsthand, harnessing that potential for robust, production-ready solutions comes with its own set of challenges. Workflow is our answer to that challenge -- it is designed to bridge the gap where single-prompt LLMs falter: generating predictable outputs with multi-step logic. 
Workflow is currently accessible as a standalone app type. It can also be activated in 'Chatbot' apps for building complex conversation flows (Chatflow). We can't wait for you to start experimenting with it now.
Chatflow is set to overtake "expert mode" in current Chatbot apps. You may choose to keep editing your existing apps in "expert mode", or transform them into workflows. "#;
    let msg = request::WorkflowsRunRequest {
        inputs: HashMap::from([
            ("input".into(), s.into()),
            ("summaryStyle".into(), "General Overview".into()),
        ]),
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().workflows_run(msg).await;
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_workflows_run_stream() {
    let client = get_client(Some("app-hxBGNNbzVsl46o20NPvSYOxB"));
    let s = r#"Hi, Gu from Dify here. I couldn't be more excited to share with you our latest feature: Workflow.
We've all seen the huge potential of LLMs in the past year. But as many of you have experienced firsthand, harnessing that potential for robust, production-ready solutions comes with its own set of challenges. Workflow is our answer to that challenge -- it is designed to bridge the gap where single-prompt LLMs falter: generating predictable outputs with multi-step logic. 
Workflow is currently accessible as a standalone app type. It can also be activated in 'Chatbot' apps for building complex conversation flows (Chatflow). We can't wait for you to start experimenting with it now.
Chatflow is set to overtake "expert mode" in current Chatbot apps. You may choose to keep editing your existing apps in "expert mode", or transform them into workflows. "#;
    let msg = request::WorkflowsRunRequest {
        inputs: HashMap::from([
            ("input".into(), s.into()),
            ("summaryStyle".into(), "General Overview".into()),
        ]),
        user: "afa".into(),
        ..Default::default()
    };

    let mut stream = client
        .api()
        .workflows_run_stream(msg)
        .await
        .expect("stream workflows run failed");

    let mut outputs = Vec::new();
    while let Some(event) = stream.next().await {
        let event = event.expect("stream mssage event failed");
        // println!("{:?}", event);
        match event {
            response::SseMessageEvent::WorkflowFinished { data, .. } => {
                let output = data
                    .outputs
                    .map(|o| o["output"].as_str().map(|s| s.to_owned()))
                    .flatten()
                    .unwrap_or_default();
                println!("output: {:?}", output);
                outputs.push(output);
            }
            response::SseMessageEvent::Error { message, .. } => {
                eprint!("error event: {}", message)
            }
            _ => {
                let event_name = serde_json::json!(event)
                    .get("event")
                    .map(|v| v.to_string())
                    .unwrap_or("unknown".into());
                println!(
                    "debug: skip dify message event: {}",
                    event_name.trim_matches('"')
                );
            }
        }
    }

    let outputs = outputs.concat();
    println!("outputs: {:?}", outputs);
}

#[tokio::test]
async fn test_workflows_stop() {
    let client = get_client(Some("app-hxBGNNbzVsl46o20NPvSYOxB"));
    let msg = request::StreamTaskStopRequest {
        task_id: "4ad31d44-7845-4dc3-893d-42211e800378".into(),
        user: "afa".into(),
    };
    let result = client.api().workflows_stop(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_completion_messages_simple() {
    let client = get_client(Some("app-EkM8znfEpsn7tvPFZfhoKp7t"));
    let msg = request::CompletionMessagesRequest {
        inputs: HashMap::from([
            ("Input_language".into(), "英文".into()),
            ("Target_language".into(), "简体中文".into()),
            (
                "default_input".into(),
                "The quick brown fox jumps over the lazy dog".into(),
            ),
        ]),
        user: "afa".into(),
        ..Default::default()
    };
    let result = client.api().completion_messages(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_completion_messages_stream() {
    let client = get_client(Some("app-EkM8znfEpsn7tvPFZfhoKp7t"));
    let msg = request::CompletionMessagesRequest {
        inputs: HashMap::from([
            ("Input_language".into(), "英文".into()),
            ("Target_language".into(), "简体中文".into()),
            (
                "default_input".into(),
                "The quick brown fox jumps over the lazy dog".into(),
            ),
        ]),
        user: "afa".into(),
        ..Default::default()
    };

    let mut stream = client
        .api()
        .completion_messages_stream(msg)
        .await
        .expect("stream completion messages failed");

    let mut outputs = Vec::new();
    while let Some(event) = stream.next().await {
        let event = event.expect("stream mssage event failed");
        match event {
            response::SseMessageEvent::Message { answer, .. } => {
                println!("answer: {:?}", answer);
                outputs.push(answer);
            }
            response::SseMessageEvent::Error { message, .. } => {
                eprint!("error event: {}", message)
            }
            _ => {
                let event_name = serde_json::json!(event)
                    .get("event")
                    .map(|v| v.to_string())
                    .unwrap_or("unknown".into());
                println!(
                    "debug: skip dify message event: {}",
                    event_name.trim_matches('"')
                );
            }
        }
    }

    let outputs = outputs.concat();
    println!("outputs: {}", outputs);
}

#[tokio::test]
async fn test_completion_messages_stop() {
    let client = get_client(Some("app-EkM8znfEpsn7tvPFZfhoKp7t"));
    let msg = request::StreamTaskStopRequest {
        task_id: "task_id".into(),
        user: "afa".into(),
    };
    let result = client.api().completion_messages_stop(msg).await;
    println!("{:?}", result);
    assert!(result.is_ok());
    let response = result.unwrap();
    println!("{:}", serde_json::to_string_pretty(&response).unwrap());
}

#[tokio::test]
async fn test_reuse_api() {
    let client = get_client_default();
    let mut api = client.api();
    api.before_send(|mut req| {
        let headers = req.headers_mut();
        // rewrite the authorization header
        let mut bearer_auth = header::HeaderValue::from_static("Bearer BEARER_TOKEN");
        bearer_auth.set_sensitive(true);
        headers.insert(header::AUTHORIZATION, bearer_auth);
        // rewrite the url
        let url = req.url_mut();
        url.set_host(Some("api.dify.ai")).unwrap();
        url.set_port(None).unwrap();
        url.set_scheme("https").unwrap();
        // println!("{:?}", url);
        println!("{:?}", req);
        req
    });

    let msg = request::ChatMessagesRequest {
        query: "how are you?".into(),
        user: "afa".into(),
        ..Default::default()
    };
    let msg1 = msg.clone();
    let result = api.chat_messages(msg).await;
    println!("{:?}\n", result);

    let result1 = api.chat_messages(msg1).await;
    println!("{:?}\n", result1);
}