pub struct ChatCompletionRequest {Show 17 fields
pub model: String,
pub messages: Vec<ChatCompletionMessage>,
pub temperature: Option<f64>,
pub top_p: Option<f64>,
pub n: Option<i64>,
pub response_format: Option<Value>,
pub stream: Option<bool>,
pub stop: Option<Vec<String>>,
pub max_tokens: Option<i64>,
pub presence_penalty: Option<f64>,
pub frequency_penalty: Option<f64>,
pub logit_bias: Option<HashMap<String, i32>>,
pub user: Option<String>,
pub seed: Option<i64>,
pub tools: Option<Vec<Tool>>,
pub parallel_tool_calls: Option<bool>,
pub tool_choice: Option<ToolChoiceType>,
}
Fields§
§model: String
§messages: Vec<ChatCompletionMessage>
§temperature: Option<f64>
§top_p: Option<f64>
§n: Option<i64>
§response_format: Option<Value>
§stream: Option<bool>
§stop: Option<Vec<String>>
§max_tokens: Option<i64>
§presence_penalty: Option<f64>
§frequency_penalty: Option<f64>
§logit_bias: Option<HashMap<String, i32>>
§user: Option<String>
§seed: Option<i64>
§tools: Option<Vec<Tool>>
§parallel_tool_calls: Option<bool>
§tool_choice: Option<ToolChoiceType>
Implementations§
Source§impl ChatCompletionRequest
impl ChatCompletionRequest
Sourcepub fn new(model: String, messages: Vec<ChatCompletionMessage>) -> Self
pub fn new(model: String, messages: Vec<ChatCompletionMessage>) -> Self
Examples found in repository?
examples/openrouter.rs (lines 14-23)
7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8 let api_key = env::var("OPENROUTER_API_KEY").unwrap().to_string();
9 let mut client = OpenAIClient::builder()
10 .with_endpoint("https://openrouter.ai/api/v1")
11 .with_api_key(api_key)
12 .build()?;
13
14 let req = ChatCompletionRequest::new(
15 GPT4_O_MINI.to_string(),
16 vec![chat_completion::ChatCompletionMessage {
17 role: chat_completion::MessageRole::user,
18 content: chat_completion::Content::Text(String::from("What is bitcoin?")),
19 name: None,
20 tool_calls: None,
21 tool_call_id: None,
22 }],
23 );
24
25 let result = client.chat_completion(req).await?;
26 println!("Content: {:?}", result.choices[0].message.content);
27 println!("Response Headers: {:?}", client.response_headers);
28
29 Ok(())
30}
More examples
examples/chat_completion.rs (lines 11-20)
7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
9 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
10
11 let req = ChatCompletionRequest::new(
12 GPT4_O_MINI.to_string(),
13 vec![chat_completion::ChatCompletionMessage {
14 role: chat_completion::MessageRole::user,
15 content: chat_completion::Content::Text(String::from("What is bitcoin?")),
16 name: None,
17 tool_calls: None,
18 tool_call_id: None,
19 }],
20 );
21
22 let result = client.chat_completion(req).await?;
23 println!("Content: {:?}", result.choices[0].message.content);
24
25 // print response headers
26 for (key, value) in client.response_headers.unwrap().iter() {
27 println!("{}: {:?}", key, value);
28 }
29
30 Ok(())
31}
examples/vision.rs (lines 11-35)
7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
9 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
10
11 let req = ChatCompletionRequest::new(
12 GPT4_O.to_string(),
13 vec![chat_completion::ChatCompletionMessage {
14 role: chat_completion::MessageRole::user,
15 content: chat_completion::Content::ImageUrl(vec![
16 chat_completion::ImageUrl {
17 r#type: chat_completion::ContentType::text,
18 text: Some(String::from("What's in this image?")),
19 image_url: None,
20 },
21 chat_completion::ImageUrl {
22 r#type: chat_completion::ContentType::image_url,
23 text: None,
24 image_url: Some(chat_completion::ImageUrlType {
25 url: String::from(
26 "https://upload.wikimedia.org/wikipedia/commons/5/50/Bitcoin.png",
27 ),
28 }),
29 },
30 ]),
31 name: None,
32 tool_calls: None,
33 tool_call_id: None,
34 }],
35 );
36
37 let result = client.chat_completion(req).await?;
38 println!("{:?}", result.choices[0].message.content);
39
40 Ok(())
41}
examples/function_call.rs (lines 33-42)
19async fn main() -> Result<(), Box<dyn std::error::Error>> {
20 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
21 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
22
23 let mut properties = HashMap::new();
24 properties.insert(
25 "coin".to_string(),
26 Box::new(types::JSONSchemaDefine {
27 schema_type: Some(types::JSONSchemaType::String),
28 description: Some("The cryptocurrency to get the price of".to_string()),
29 ..Default::default()
30 }),
31 );
32
33 let req = ChatCompletionRequest::new(
34 GPT4_O.to_string(),
35 vec![chat_completion::ChatCompletionMessage {
36 role: chat_completion::MessageRole::user,
37 content: chat_completion::Content::Text(String::from("What is the price of Ethereum?")),
38 name: None,
39 tool_calls: None,
40 tool_call_id: None,
41 }],
42 )
43 .tools(vec![chat_completion::Tool {
44 r#type: chat_completion::ToolType::Function,
45 function: types::Function {
46 name: String::from("get_coin_price"),
47 description: Some(String::from("Get the price of a cryptocurrency")),
48 parameters: types::FunctionParameters {
49 schema_type: types::JSONSchemaType::Object,
50 properties: Some(properties),
51 required: Some(vec![String::from("coin")]),
52 },
53 },
54 }])
55 .tool_choice(chat_completion::ToolChoiceType::Auto);
56
57 // debug request json
58 // let serialized = serde_json::to_string(&req).unwrap();
59 // println!("{}", serialized);
60
61 let result = client.chat_completion(req).await?;
62
63 match result.choices[0].finish_reason {
64 None => {
65 println!("No finish_reason");
66 println!("{:?}", result.choices[0].message.content);
67 }
68 Some(chat_completion::FinishReason::stop) => {
69 println!("Stop");
70 println!("{:?}", result.choices[0].message.content);
71 }
72 Some(chat_completion::FinishReason::length) => {
73 println!("Length");
74 }
75 Some(chat_completion::FinishReason::tool_calls) => {
76 println!("ToolCalls");
77 #[derive(Deserialize, Serialize)]
78 struct Currency {
79 coin: String,
80 }
81 let tool_calls = result.choices[0].message.tool_calls.as_ref().unwrap();
82 for tool_call in tool_calls {
83 let name = tool_call.function.name.clone().unwrap();
84 let arguments = tool_call.function.arguments.clone().unwrap();
85 let c: Currency = serde_json::from_str(&arguments)?;
86 let coin = c.coin;
87 if name == "get_coin_price" {
88 let price = get_coin_price(&coin);
89 println!("{} price: {}", coin, price);
90 }
91 }
92 }
93 Some(chat_completion::FinishReason::content_filter) => {
94 println!("ContentFilter");
95 }
96 Some(chat_completion::FinishReason::null) => {
97 println!("Null");
98 }
99 }
100 Ok(())
101}
examples/function_call_role.rs (lines 33-42)
19async fn main() -> Result<(), Box<dyn std::error::Error>> {
20 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
21 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
22
23 let mut properties = HashMap::new();
24 properties.insert(
25 "coin".to_string(),
26 Box::new(types::JSONSchemaDefine {
27 schema_type: Some(types::JSONSchemaType::String),
28 description: Some("The cryptocurrency to get the price of".to_string()),
29 ..Default::default()
30 }),
31 );
32
33 let req = ChatCompletionRequest::new(
34 GPT4_O.to_string(),
35 vec![chat_completion::ChatCompletionMessage {
36 role: chat_completion::MessageRole::user,
37 content: chat_completion::Content::Text(String::from("What is the price of Ethereum?")),
38 name: None,
39 tool_calls: None,
40 tool_call_id: None,
41 }],
42 )
43 .tools(vec![chat_completion::Tool {
44 r#type: chat_completion::ToolType::Function,
45 function: types::Function {
46 name: String::from("get_coin_price"),
47 description: Some(String::from("Get the price of a cryptocurrency")),
48 parameters: types::FunctionParameters {
49 schema_type: types::JSONSchemaType::Object,
50 properties: Some(properties),
51 required: Some(vec![String::from("coin")]),
52 },
53 },
54 }]);
55
56 let result = client.chat_completion(req).await?;
57
58 match result.choices[0].finish_reason {
59 None => {
60 println!("No finish_reason");
61 println!("{:?}", result.choices[0].message.content);
62 }
63 Some(chat_completion::FinishReason::stop) => {
64 println!("Stop");
65 println!("{:?}", result.choices[0].message.content);
66 }
67 Some(chat_completion::FinishReason::length) => {
68 println!("Length");
69 }
70 Some(chat_completion::FinishReason::tool_calls) => {
71 println!("ToolCalls");
72 #[derive(Deserialize, Serialize)]
73 struct Currency {
74 coin: String,
75 }
76 let tool_calls = result.choices[0].message.tool_calls.as_ref().unwrap();
77 for tool_call in tool_calls {
78 let function_call = &tool_call.function;
79 let arguments = function_call.arguments.clone().unwrap();
80 let c: Currency = serde_json::from_str(&arguments)?;
81 let coin = c.coin;
82 println!("coin: {}", coin);
83 let price = get_coin_price(&coin);
84 println!("price: {}", price);
85
86 let req = ChatCompletionRequest::new(
87 GPT4_O.to_string(),
88 vec![
89 chat_completion::ChatCompletionMessage {
90 role: chat_completion::MessageRole::user,
91 content: chat_completion::Content::Text(String::from(
92 "What is the price of Ethereum?",
93 )),
94 name: None,
95 tool_calls: None,
96 tool_call_id: None,
97 },
98 chat_completion::ChatCompletionMessage {
99 role: chat_completion::MessageRole::function,
100 content: chat_completion::Content::Text({
101 let price = get_coin_price(&coin);
102 format!("{{\"price\": {}}}", price)
103 }),
104 name: Some(String::from("get_coin_price")),
105 tool_calls: None,
106 tool_call_id: None,
107 },
108 ],
109 );
110
111 let result = client.chat_completion(req).await?;
112 println!("{:?}", result.choices[0].message.content);
113 }
114 }
115 Some(chat_completion::FinishReason::content_filter) => {
116 println!("ContentFilter");
117 }
118 Some(chat_completion::FinishReason::null) => {
119 println!("Null");
120 }
121 }
122 Ok(())
123}
Source§impl ChatCompletionRequest
impl ChatCompletionRequest
pub fn temperature(self, temperature: f64) -> Self
pub fn top_p(self, top_p: f64) -> Self
pub fn n(self, n: i64) -> Self
pub fn response_format(self, response_format: Value) -> Self
pub fn stream(self, stream: bool) -> Self
pub fn stop(self, stop: Vec<String>) -> Self
pub fn max_tokens(self, max_tokens: i64) -> Self
pub fn presence_penalty(self, presence_penalty: f64) -> Self
pub fn frequency_penalty(self, frequency_penalty: f64) -> Self
pub fn logit_bias(self, logit_bias: HashMap<String, i32>) -> Self
pub fn user(self, user: String) -> Self
pub fn seed(self, seed: i64) -> Self
Sourcepub fn tools(self, tools: Vec<Tool>) -> Self
pub fn tools(self, tools: Vec<Tool>) -> Self
Examples found in repository?
examples/function_call.rs (lines 43-54)
19async fn main() -> Result<(), Box<dyn std::error::Error>> {
20 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
21 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
22
23 let mut properties = HashMap::new();
24 properties.insert(
25 "coin".to_string(),
26 Box::new(types::JSONSchemaDefine {
27 schema_type: Some(types::JSONSchemaType::String),
28 description: Some("The cryptocurrency to get the price of".to_string()),
29 ..Default::default()
30 }),
31 );
32
33 let req = ChatCompletionRequest::new(
34 GPT4_O.to_string(),
35 vec![chat_completion::ChatCompletionMessage {
36 role: chat_completion::MessageRole::user,
37 content: chat_completion::Content::Text(String::from("What is the price of Ethereum?")),
38 name: None,
39 tool_calls: None,
40 tool_call_id: None,
41 }],
42 )
43 .tools(vec![chat_completion::Tool {
44 r#type: chat_completion::ToolType::Function,
45 function: types::Function {
46 name: String::from("get_coin_price"),
47 description: Some(String::from("Get the price of a cryptocurrency")),
48 parameters: types::FunctionParameters {
49 schema_type: types::JSONSchemaType::Object,
50 properties: Some(properties),
51 required: Some(vec![String::from("coin")]),
52 },
53 },
54 }])
55 .tool_choice(chat_completion::ToolChoiceType::Auto);
56
57 // debug request json
58 // let serialized = serde_json::to_string(&req).unwrap();
59 // println!("{}", serialized);
60
61 let result = client.chat_completion(req).await?;
62
63 match result.choices[0].finish_reason {
64 None => {
65 println!("No finish_reason");
66 println!("{:?}", result.choices[0].message.content);
67 }
68 Some(chat_completion::FinishReason::stop) => {
69 println!("Stop");
70 println!("{:?}", result.choices[0].message.content);
71 }
72 Some(chat_completion::FinishReason::length) => {
73 println!("Length");
74 }
75 Some(chat_completion::FinishReason::tool_calls) => {
76 println!("ToolCalls");
77 #[derive(Deserialize, Serialize)]
78 struct Currency {
79 coin: String,
80 }
81 let tool_calls = result.choices[0].message.tool_calls.as_ref().unwrap();
82 for tool_call in tool_calls {
83 let name = tool_call.function.name.clone().unwrap();
84 let arguments = tool_call.function.arguments.clone().unwrap();
85 let c: Currency = serde_json::from_str(&arguments)?;
86 let coin = c.coin;
87 if name == "get_coin_price" {
88 let price = get_coin_price(&coin);
89 println!("{} price: {}", coin, price);
90 }
91 }
92 }
93 Some(chat_completion::FinishReason::content_filter) => {
94 println!("ContentFilter");
95 }
96 Some(chat_completion::FinishReason::null) => {
97 println!("Null");
98 }
99 }
100 Ok(())
101}
More examples
examples/function_call_role.rs (lines 43-54)
19async fn main() -> Result<(), Box<dyn std::error::Error>> {
20 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
21 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
22
23 let mut properties = HashMap::new();
24 properties.insert(
25 "coin".to_string(),
26 Box::new(types::JSONSchemaDefine {
27 schema_type: Some(types::JSONSchemaType::String),
28 description: Some("The cryptocurrency to get the price of".to_string()),
29 ..Default::default()
30 }),
31 );
32
33 let req = ChatCompletionRequest::new(
34 GPT4_O.to_string(),
35 vec![chat_completion::ChatCompletionMessage {
36 role: chat_completion::MessageRole::user,
37 content: chat_completion::Content::Text(String::from("What is the price of Ethereum?")),
38 name: None,
39 tool_calls: None,
40 tool_call_id: None,
41 }],
42 )
43 .tools(vec![chat_completion::Tool {
44 r#type: chat_completion::ToolType::Function,
45 function: types::Function {
46 name: String::from("get_coin_price"),
47 description: Some(String::from("Get the price of a cryptocurrency")),
48 parameters: types::FunctionParameters {
49 schema_type: types::JSONSchemaType::Object,
50 properties: Some(properties),
51 required: Some(vec![String::from("coin")]),
52 },
53 },
54 }]);
55
56 let result = client.chat_completion(req).await?;
57
58 match result.choices[0].finish_reason {
59 None => {
60 println!("No finish_reason");
61 println!("{:?}", result.choices[0].message.content);
62 }
63 Some(chat_completion::FinishReason::stop) => {
64 println!("Stop");
65 println!("{:?}", result.choices[0].message.content);
66 }
67 Some(chat_completion::FinishReason::length) => {
68 println!("Length");
69 }
70 Some(chat_completion::FinishReason::tool_calls) => {
71 println!("ToolCalls");
72 #[derive(Deserialize, Serialize)]
73 struct Currency {
74 coin: String,
75 }
76 let tool_calls = result.choices[0].message.tool_calls.as_ref().unwrap();
77 for tool_call in tool_calls {
78 let function_call = &tool_call.function;
79 let arguments = function_call.arguments.clone().unwrap();
80 let c: Currency = serde_json::from_str(&arguments)?;
81 let coin = c.coin;
82 println!("coin: {}", coin);
83 let price = get_coin_price(&coin);
84 println!("price: {}", price);
85
86 let req = ChatCompletionRequest::new(
87 GPT4_O.to_string(),
88 vec![
89 chat_completion::ChatCompletionMessage {
90 role: chat_completion::MessageRole::user,
91 content: chat_completion::Content::Text(String::from(
92 "What is the price of Ethereum?",
93 )),
94 name: None,
95 tool_calls: None,
96 tool_call_id: None,
97 },
98 chat_completion::ChatCompletionMessage {
99 role: chat_completion::MessageRole::function,
100 content: chat_completion::Content::Text({
101 let price = get_coin_price(&coin);
102 format!("{{\"price\": {}}}", price)
103 }),
104 name: Some(String::from("get_coin_price")),
105 tool_calls: None,
106 tool_call_id: None,
107 },
108 ],
109 );
110
111 let result = client.chat_completion(req).await?;
112 println!("{:?}", result.choices[0].message.content);
113 }
114 }
115 Some(chat_completion::FinishReason::content_filter) => {
116 println!("ContentFilter");
117 }
118 Some(chat_completion::FinishReason::null) => {
119 println!("Null");
120 }
121 }
122 Ok(())
123}
pub fn parallel_tool_calls(self, parallel_tool_calls: bool) -> Self
Sourcepub fn tool_choice(self, tool_choice: ToolChoiceType) -> Self
pub fn tool_choice(self, tool_choice: ToolChoiceType) -> Self
Examples found in repository?
examples/function_call.rs (line 55)
19async fn main() -> Result<(), Box<dyn std::error::Error>> {
20 let api_key = env::var("OPENAI_API_KEY").unwrap().to_string();
21 let mut client = OpenAIClient::builder().with_api_key(api_key).build()?;
22
23 let mut properties = HashMap::new();
24 properties.insert(
25 "coin".to_string(),
26 Box::new(types::JSONSchemaDefine {
27 schema_type: Some(types::JSONSchemaType::String),
28 description: Some("The cryptocurrency to get the price of".to_string()),
29 ..Default::default()
30 }),
31 );
32
33 let req = ChatCompletionRequest::new(
34 GPT4_O.to_string(),
35 vec![chat_completion::ChatCompletionMessage {
36 role: chat_completion::MessageRole::user,
37 content: chat_completion::Content::Text(String::from("What is the price of Ethereum?")),
38 name: None,
39 tool_calls: None,
40 tool_call_id: None,
41 }],
42 )
43 .tools(vec![chat_completion::Tool {
44 r#type: chat_completion::ToolType::Function,
45 function: types::Function {
46 name: String::from("get_coin_price"),
47 description: Some(String::from("Get the price of a cryptocurrency")),
48 parameters: types::FunctionParameters {
49 schema_type: types::JSONSchemaType::Object,
50 properties: Some(properties),
51 required: Some(vec![String::from("coin")]),
52 },
53 },
54 }])
55 .tool_choice(chat_completion::ToolChoiceType::Auto);
56
57 // debug request json
58 // let serialized = serde_json::to_string(&req).unwrap();
59 // println!("{}", serialized);
60
61 let result = client.chat_completion(req).await?;
62
63 match result.choices[0].finish_reason {
64 None => {
65 println!("No finish_reason");
66 println!("{:?}", result.choices[0].message.content);
67 }
68 Some(chat_completion::FinishReason::stop) => {
69 println!("Stop");
70 println!("{:?}", result.choices[0].message.content);
71 }
72 Some(chat_completion::FinishReason::length) => {
73 println!("Length");
74 }
75 Some(chat_completion::FinishReason::tool_calls) => {
76 println!("ToolCalls");
77 #[derive(Deserialize, Serialize)]
78 struct Currency {
79 coin: String,
80 }
81 let tool_calls = result.choices[0].message.tool_calls.as_ref().unwrap();
82 for tool_call in tool_calls {
83 let name = tool_call.function.name.clone().unwrap();
84 let arguments = tool_call.function.arguments.clone().unwrap();
85 let c: Currency = serde_json::from_str(&arguments)?;
86 let coin = c.coin;
87 if name == "get_coin_price" {
88 let price = get_coin_price(&coin);
89 println!("{} price: {}", coin, price);
90 }
91 }
92 }
93 Some(chat_completion::FinishReason::content_filter) => {
94 println!("ContentFilter");
95 }
96 Some(chat_completion::FinishReason::null) => {
97 println!("Null");
98 }
99 }
100 Ok(())
101}
Trait Implementations§
Source§impl Clone for ChatCompletionRequest
impl Clone for ChatCompletionRequest
Source§fn clone(&self) -> ChatCompletionRequest
fn clone(&self) -> ChatCompletionRequest
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for ChatCompletionRequest
impl Debug for ChatCompletionRequest
Source§impl<'de> Deserialize<'de> for ChatCompletionRequest
impl<'de> Deserialize<'de> for ChatCompletionRequest
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations§
impl Freeze for ChatCompletionRequest
impl RefUnwindSafe for ChatCompletionRequest
impl Send for ChatCompletionRequest
impl Sync for ChatCompletionRequest
impl Unpin for ChatCompletionRequest
impl UnwindSafe for ChatCompletionRequest
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more