async_llm/types/chat_function.rs
1use serde::{Deserialize, Serialize};
2
3#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
4pub struct ChatFunction {
5 /// The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
6 pub name: String,
7
8 /// A description of what the function does, used by the model to choose when and how to call the function.
9 #[serde(skip_serializing_if = "Option::is_none")]
10 pub description: Option<String>,
11
12 /// The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
13 ///
14 /// Omitting `parameters` defines a function with an empty parameter list.
15 #[serde(skip_serializing_if = "Option::is_none")]
16 pub parameters: Option<serde_json::Value>,
17}