typesense_codegen 0.30.0

Types for typesense generated with openapi spec
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

/*
 * Typesense API
 *
 * An open source search engine for building delightful search experiences.
 *
 * The version of the OpenAPI document: 30.0
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use ::std::borrow::Cow;
use serde::{Deserialize, Serialize};

#[derive(bon::Builder)]
#[builder(on(Cow<'_, str>, into))]
#[builder(on(String, into))]
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Field {
    #[serde(rename = "name")]
    pub name: String,
    #[serde(rename = "type")]
    pub r#type: String,
    #[serde(rename = "optional", skip_serializing_if = "Option::is_none")]
    pub optional: Option<bool>,
    #[serde(rename = "facet", skip_serializing_if = "Option::is_none")]
    pub facet: Option<bool>,
    #[serde(rename = "index", skip_serializing_if = "Option::is_none")]
    pub index: Option<bool>,
    #[serde(rename = "locale", skip_serializing_if = "Option::is_none")]
    pub locale: Option<String>,
    #[serde(rename = "sort", skip_serializing_if = "Option::is_none")]
    pub sort: Option<bool>,
    #[serde(rename = "infix", skip_serializing_if = "Option::is_none")]
    pub infix: Option<bool>,
    /// Name of a field in another collection that should be linked to this collection so that it can be joined during query.
    #[serde(rename = "reference", skip_serializing_if = "Option::is_none")]
    pub reference: Option<String>,
    /// Allow documents to be indexed successfully even when the referenced document doesn't exist yet.
    #[serde(rename = "async_reference", skip_serializing_if = "Option::is_none")]
    pub async_reference: Option<bool>,
    #[serde(rename = "num_dim", skip_serializing_if = "Option::is_none")]
    pub num_dim: Option<i32>,
    #[serde(rename = "drop", skip_serializing_if = "Option::is_none")]
    pub drop: Option<bool>,
    /// When set to false, the field value will not be stored on disk. Default: true.
    #[serde(rename = "store", skip_serializing_if = "Option::is_none")]
    pub store: Option<bool>,
    /// The distance metric to be used for vector search. Default: `cosine`. You can also use `ip` for inner product.
    #[serde(rename = "vec_dist", skip_serializing_if = "Option::is_none")]
    pub vec_dist: Option<String>,
    /// Enables an index optimized for range filtering on numerical fields (e.g. rating:>3.5). Default: false.
    #[serde(rename = "range_index", skip_serializing_if = "Option::is_none")]
    pub range_index: Option<bool>,
    /// Values are stemmed before indexing in-memory. Default: false.
    #[serde(rename = "stem", skip_serializing_if = "Option::is_none")]
    pub stem: Option<bool>,
    /// Name of the stemming dictionary to use for this field
    #[serde(rename = "stem_dictionary", skip_serializing_if = "Option::is_none")]
    pub stem_dictionary: Option<String>,
    /// List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.
    #[serde(rename = "token_separators", skip_serializing_if = "Option::is_none")]
    pub token_separators: Option<Vec<String>>,
    /// List of symbols or special characters to be indexed.
    #[serde(rename = "symbols_to_index", skip_serializing_if = "Option::is_none")]
    pub symbols_to_index: Option<Vec<String>>,
    #[serde(rename = "embed", skip_serializing_if = "Option::is_none")]
    pub embed: Option<Box<models::FieldEmbed>>,
}

impl Field {
    pub fn new(name: String, r#type: String) -> Self {
        Self {
            name,
            r#type,
            optional: None,
            facet: None,
            index: None,
            locale: None,
            sort: None,
            infix: None,
            reference: None,
            async_reference: None,
            num_dim: None,
            drop: None,
            store: None,
            vec_dist: None,
            range_index: None,
            stem: None,
            stem_dictionary: None,
            token_separators: None,
            symbols_to_index: None,
            embed: None,
        }
    }
}