Edit message
This will delete the specified message and replace it with a new message. All messages after the message being edited in the sort order will be deleted. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like [chunks]||mesage
. See docs.trieve.ai for more information. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
Authorizations
Headers
The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.
Body
The sort order of the message to edit.
The id of the topic to edit the message at the given sort order for.
The base64 encoded audio input of the user message to attach to the topic and then generate an assistant message in response to.
If concat user messages query is set to true, all of the user messages in the topic will be concatenated together and used as the search query. If not specified, this defaults to false. Default is false.
Context options to use for the completion. If not specified, all options will default to false.
ChunkFilter is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.
{
"must": [
{
"field": "tag_set",
"match_all": ["A", "B"]
},
{
"field": "num_value",
"range": { "gte": 10, "lte": 25 }
}
]
}
Highlight Options lets you specify different methods to highlight the chunks in the result set. If not specified, this defaults to the score of the chunks.
The URL of the image(s) to attach to the message.
LLM options to use for the completion. If not specified, this defaults to the dataset's LLM options.
Metadata is any metadata you want to associate w/ the event that is created from this request
The new content of the message to replace the old content with.
No result message for when there are no chunks found above the score threshold.
Only include docs used in the completion. If not specified, this defaults to false.
Page size is the number of chunks to fetch during RAG. If 0, then no search will be performed. If specified, this will override the N retrievals to include in the dataset configuration. Default is None.
x >= 0
If true, stop words (specified in server/src/stop-words.txt in the git repo) will be removed. Queries that are entirely stop words will be preserved.
Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0.
Query is the search query. This can be any string. The search_query will be used to create a dense embedding vector and/or sparse vector which will be used to find the result set. If not specified, will default to the last user message or HyDE if HyDE is enabled in the dataset configuration. Default is None.
fulltext
, semantic
, hybrid
, bm25
Sort Options lets you specify different methods to rerank the chunks in the result set. If not specified, this defaults to the score of the chunks.
Typo Options lets you specify different methods to correct typos in the query. If not specified, typos will not be corrected.
If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively. Default is false.
The user_id is the id of the user who is making the request. This is used to track user interactions with the RAG results.
Response
This will be a HTTP stream, check the chat or search UI for an example how to process this
Was this page helpful?