cohere-rust 0.6.0

This crate provides a simplified interface with the Cohere API in Rust
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

use serde::{Deserialize, Serialize};

use super::GenerateModel;

#[derive(Serialize, Default, Debug)]
pub struct ChatRequest<'input> {
    /// The chat message from the user to the model.
    pub message: &'input str,
    /// optional - The model to use for text generation. Custom models can also be supplied with their full ID. Defaults to 'command'.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub model: Option<GenerateModel>,
    /// optional - Dictates how the prompt will be constructed. When set to 'AUTO' some parts of chat history and documents will be dropped
    /// to construct a prompt that fits within the model's context length limit.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prompt_truncation: Option<PromptTruncation>,
    /// optional - A non-negative float that tunes the degree of randomness in generation.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub temperature: Option<f64>,
    /// optional - Previous conversations can be stored and resumed by providing the conversation's identifier.
    /// If a conversation with this id does not already exist, a new conversation will be created.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub conversation_id: Option<String>,
    /// optional - A list of previous messages between the user and the model,
    /// meant to give the model conversational context for responding to the user's message.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub chat_history: Option<&'input Vec<ChatMessage>>,
    // optional - When specified, the default Cohere preamble will be replaced with the provided one.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub preamble: Option<String>,
    // optional - The maximum number of tokens the model will generate as part of the response.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_tokens: Option<u64>,
    // optional - Ensures only the top k most likely tokens are considered for generation at each step
    #[serde(skip_serializing_if = "Option::is_none")]
    pub k: Option<u64>,
}

#[derive(Serialize, Deserialize, Debug, PartialEq)]
#[serde(tag = "role")]
pub enum ChatMessage {
    #[serde(rename = "CHATBOT")]
    Chatbot { message: String },
    #[serde(rename = "USER")]
    User { message: String },
}

#[derive(Serialize, Debug)]
pub(crate) struct ChatStreamRequest<'input> {
    #[serde(flatten)]
    pub request: &'input ChatRequest<'input>,
    pub stream: bool,
}

#[derive(strum_macros::Display, Serialize, Debug)]
pub enum PromptTruncation {
    #[strum(serialize = "AUTO")]
    #[serde(rename = "AUTO")]
    Auto,
    #[strum(serialize = "OFF")]
    #[serde(rename = "OFF")]
    Off,
}

#[derive(strum_macros::Display, Serialize, Debug)]
pub enum CitationQuality {
    #[strum(serialize = "accurate")]
    #[serde(rename = "accurate")]
    Accurate,
    #[strum(serialize = "fast")]
    #[serde(rename = "fast")]
    Fast,
}

#[derive(Deserialize, Debug, PartialEq)]
pub struct ChatResponse {
    pub generation_id: String,
    pub response_id: String,
    pub text: String,
}

#[derive(Deserialize, Debug, PartialEq)]
#[serde(tag = "event_type")]
pub enum ChatStreamResponse {
    #[serde(rename = "stream-start")]
    ChatStreamStart {
        generation_id: String,
        is_finished: bool,
    },
    #[serde(rename = "text-generation")]
    ChatTextGeneration { is_finished: bool, text: String },
    #[serde(rename = "stream-end")]
    ChatStreamEnd {
        finish_reason: String,
        is_finished: bool,
        response: ChatResponse,
    },
}