openai_struct/models/
assistant_tools_file_search.rs

1/*
2 * OpenAI API
3 *
4 * The OpenAI REST API. Please see pub https://platform.openai.com/docs/api-reference for more details.
5 *
6 * OpenAPI spec pub version: 2.3.0
7 *
8 * Generated pub by: https://github.com/swagger-api/swagger-codegen.git
9 */
10
11#[allow(unused_imports)]
12use serde_json::Value;
13
14/// # on openapi.yaml
15///
16/// ```yaml
17/// AssistantToolsFileSearch:
18///   type: object
19///   title: FileSearch tool
20///   properties:
21///     type:
22///       type: string
23///       description: "The type of tool being defined: `file_search`"
24///       enum:
25///         - file_search
26///       x-stainless-const: true
27///     file_search:
28///       type: object
29///       description: Overrides for the file search tool.
30///       properties:
31///         max_num_results:
32///           type: integer
33///           minimum: 1
34///           maximum: 50
35///           description: |
36///             The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive.
37///
38///             Note that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.
39///         ranking_options:
40///           $ref: "#/components/schemas/FileSearchRankingOptions"
41///   required:
42///     - type
43/// ```
44#[derive(Debug, Serialize, Deserialize)]
45pub struct AssistantToolsFileSearch {
46    #[serde(rename = "file_search")]
47    pub file_search: Option<crate::models::AssistantToolsFileSearchFileSearch>,
48    /// The type of tool being defined: `file_search`
49    #[serde(rename = "type")]
50    pub _type: String,
51}