Struct GenerateOffChunksReqPayload

pub struct GenerateOffChunksReqPayload {
    pub chunk_ids: Vec<Uuid>,
    pub frequency_penalty: Option<Option<f32>>,
    pub highlight_results: Option<Option<bool>>,
    pub max_tokens: Option<Option<i32>>,
    pub presence_penalty: Option<Option<f32>>,
    pub prev_messages: Vec<ChatMessageProxy>,
    pub prompt: Option<Option<String>>,
    pub stop_tokens: Option<Option<Vec<String>>>,
    pub stream_response: Option<Option<bool>>,
    pub temperature: Option<Option<f32>>,
    pub user_id: Option<Option<String>>,
}

Fields

chunk_ids: Vec<Uuid>

The ids of the chunks to be retrieved and injected into the context window for RAG.

frequency_penalty: Option<Option<f32>>

Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim. Default is 0.7.

highlight_results: Option<Option<bool>>

Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching splits.

max_tokens: Option<Option<i32>>

The maximum number of tokens to generate in the chat completion. Default is None.

presence_penalty: Option<Option<f32>>

Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics. Default is 0.7.

prev_messages: Vec<ChatMessageProxy>

The previous messages to be placed into the chat history. There must be at least one previous message.

prompt: Option<Option<String>>

Prompt will be used to tell the model what to generate in the next message in the chat. The default is ‘Respond to the previous instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:’. You can also specify an empty string to leave the final message alone such that your user’s final message can be used as the prompt. See docs.trieve.ai or contact us for more information.

stop_tokens: Option<Option<Vec<String>>>

Stop tokens are up to 4 sequences where the API will stop generating further tokens. Default is None.

stream_response: Option<Option<bool>>

Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true.

temperature: Option<Option<f32>>

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.5.

user_id: Option<Option<String>>

User ID is the id of the user who is making the request. This is used to track user interactions with the RAG results.

Implementations

impl GenerateOffChunksReqPayload

pub fn new( chunk_ids: Vec<Uuid>, prev_messages: Vec<ChatMessageProxy>, ) -> GenerateOffChunksReqPayload

Trait Implementations

impl Clone for GenerateOffChunksReqPayload

fn clone(&self) -> GenerateOffChunksReqPayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GenerateOffChunksReqPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GenerateOffChunksReqPayload

fn default() -> GenerateOffChunksReqPayload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GenerateOffChunksReqPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GenerateOffChunksReqPayload

fn eq(&self, other: &GenerateOffChunksReqPayload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GenerateOffChunksReqPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GenerateOffChunksReqPayload