POST
/
api
/
message
curl --request POST \
  --url https://api.trieve.ai/api/message \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "audio_input": "<string>",
  "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>"
  },
  "image_urls": [
    "<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>",
  "new_message_content": "<string>",
  "no_result_message": "<string>",
  "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": 123,
        "lon": 123
      }
    },
    "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_group_search": true,
  "use_quote_negated_terms": true,
  "user_id": "<string>"
}'
"<string>"

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string
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 create a message completion

The body is of type object.

Response

200
text/plain

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.