DELETE
/
api
/
message
Regenerate message
curl --request DELETE \
  --url https://api.trieve.ai/api/message \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "concat_user_messages_query": true,
  "context_options": {
    "include_links": true
  },
  "currency": "<string>",
  "filters": {
    "must": [
      {
        "field": "tag_set",
        "match_all": [
          "A",
          "B"
        ]
      },
      {
        "field": "num_value",
        "range": {
          "gte": 10,
          "lte": 25
        }
      }
    ]
  },
  "highlight_options": {
    "highlight_delimiters": [
      "<string>"
    ],
    "highlight_max_length": 1,
    "highlight_max_num": 1,
    "highlight_results": true,
    "highlight_strategy": "exactmatch",
    "highlight_threshold": 123,
    "highlight_window": 1,
    "post_tag": "<string>",
    "pre_tag": "<string>"
  },
  "llm_options": {
    "completion_first": true,
    "frequency_penalty": 123,
    "image_config": {
      "images_per_chunk": 1,
      "use_images": true
    },
    "max_tokens": 1,
    "presence_penalty": 123,
    "stop_tokens": [
      "<string>"
    ],
    "stream_response": true,
    "system_prompt": "<string>",
    "temperature": 123
  },
  "metadata": "<any>",
  "model": "<string>",
  "no_result_message": "<string>",
  "number_of_messages_to_include": 1,
  "only_include_docs_used": true,
  "page_size": 1,
  "rag_context": "<string>",
  "remove_stop_words": true,
  "score_threshold": 123,
  "search_query": "<string>",
  "search_type": "fulltext",
  "sort_options": {
    "location_bias": {
      "bias": 123,
      "location": {
        "lat": "<any>",
        "lon": "<any>"
      }
    },
    "mmr": {
      "mmr_lambda": 123,
      "use_mmr": true
    },
    "recency_bias": 123,
    "sort_by": {
      "direction": "desc",
      "field": "<string>",
      "prefetch_amount": 1
    },
    "tag_weights": {},
    "use_weights": true
  },
  "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "typo_options": {
    "correct_typos": true,
    "disable_on_word": [
      "<string>"
    ],
    "one_typo_word_range": {
      "max": 1,
      "min": 1
    },
    "prioritize_domain_specifc_words": true,
    "two_typo_word_range": {
      "max": 1,
      "min": 1
    }
  },
  "use_agentic_search": true,
  "use_group_search": true,
  "use_quote_negated_terms": true,
  "user_id": "<string>"
}'
"<string>"

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string<uuid>
required

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

application/json

JSON request payload to delete an agent message then regenerate it in a strem

​
topic_id
string<uuid>
required

The id of the topic to regenerate the last message for.

​
concat_user_messages_query
boolean | null

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
object

Context options to use for the completion. If not specified, all options will default to false.

​
currency
string | null

The currency symbol to use for the completion. If not specified, this defaults to "$".

​
filters
object

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.

Example:
{
  "must": [
    {
      "field": "tag_set",
      "match_all": ["A", "B"]
    },
    {
      "field": "num_value",
      "range": { "gte": 10, "lte": 25 }
    }
  ]
}
​
highlight_options
object

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.

​
llm_options
object

LLM options to use for the completion. If not specified, this defaults to the dataset's LLM options.

​
metadata
any

Metadata is any metadata you want to associate w/ the event that is created from this request

​
model
string | null

Model name to use for the completion. If not specified, this defaults to the dataset's model.

​
no_result_message
string | null

No result message for when there are no chunks found above the score threshold.

​
number_of_messages_to_include
integer | null

Number of messages to include in the context window. If not specified, this defaults to 10.

Required range: x >= 0
​
only_include_docs_used
boolean | null

Only include docs used is a boolean that indicates whether or not to only include the docs that were used in the completion. If true, the completion will only include the docs that were used in the completion. If false, the completion will include all of the docs.

​
page_size
integer | null

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.

Required range: x >= 0
​
rag_context
string | null

Overrides what the way chunks are placed into the context window

​
remove_stop_words
boolean | null

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.

​
score_threshold
number | null

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.

​
search_query
string | null

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.

​
search_type
enum<string>
Available options:
fulltext,
semantic,
hybrid,
bm25
​
sort_options
object

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
object

Typo Options lets you specify different methods to correct typos in the query. If not specified, typos will not be corrected.

​
use_agentic_search
boolean | null

If true, the search will be conducted using llm tool calling. If not specified, this defaults to false.

​
use_group_search
boolean | null

If use_group_search is set to true, the search will be conducted using the search_over_groups api. If not specified, this defaults to false.

​
use_quote_negated_terms
boolean | null

If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively. Default is false.

​
user_id
string | null

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 JSON response of a string containing the LLM's generated inference. Response if not streaming.

The response is of type string.