TrieveRubyClient::EditMessageReqPayload
Properties
| Name |
Type |
Description |
Notes |
| completion_first |
Boolean |
Completion first decides whether the stream should contain the stream of the completion response or the chunks first. Default is false. Keep in mind that |
|
| filters |
ChunkFilter |
|
[optional] |
| frequency_penalty |
Float |
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. |
[optional] |
| highlight_citations |
Boolean |
Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. |
[optional] |
| highlight_delimiters |
Array<String> |
The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[".", "!", "?", "\n", "\t", ","]`. |
[optional] |
| max_tokens |
Integer |
The maximum number of tokens to generate in the chat completion. |
[optional] |
| message_sort_order |
Integer |
The sort order of the message to edit. |
|
| new_message_content |
String |
The new content of the message to replace the old content with. |
|
| presence_penalty |
Float |
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. |
[optional] |
| search_type |
String |
Search_type can be either "semantic", "fulltext", or "hybrid". "hybrid" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. "semantic" will pull in one page (10 chunks) of the nearest cosine distant vectors. "fulltext" will pull in one page (10 chunks) of full-text results based on SPLADE. |
[optional] |
| stop_tokens |
Array<String> |
Stop tokens are up to 4 sequences where the API will stop generating further tokens. |
[optional] |
| stream_response |
Boolean |
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. |
[optional] |
| temperature |
Float |
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.7. |
[optional] |
| topic_id |
String |
The id of the topic to edit the message at the given sort order for. |
|
Example
require 'trieve_ruby_client'
instance = TrieveRubyClient::EditMessageReqPayload.new(
completion_first: null,
filters: null,
frequency_penalty: null,
highlight_citations: null,
highlight_delimiters: null,
max_tokens: null,
message_sort_order: null,
new_message_content: null,
presence_penalty: null,
search_type: null,
stop_tokens: null,
stream_response: null,
temperature: null,
topic_id: null
)