Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.trieve.ai/llms.txt

Use this file to discover all available pages before exploring further.

{
  "query": "What are some good electric cars",
  "texts": [
      "Here’s the information about the Mercedes CLR GTR: The Mercedes CLR GTR is a remarkable racing car ...",
      "The Tesla Cybertruck is an all-electric, battery-powered light-duty truck unveiled by Tesla, Inc. ..."
  ],
  "raw_scores": false,
  "return_text": false,
  "truncate": false,
  "truncation_direction": "right"
}

[
    {
        "index":1,
        "score":0.15253653,
        // if return_text = true
        "text": "The Tesla Cybertruck is an all-electric, battery-powered light-duty truck unveiled by Tesla, Inc. ..."
    },
    {
        "index":0,
        "score":0.00498227
        // if return_text = true
        "text": "Here’s the information about the Mercedes CLR GTR: The Mercedes CLR GTR is a remarkable racing car ..."
    }
]
​
query
string
required
Inputs that need to be embedded
​
texts
string[]
required
Inputs that need to be embedded
​
raw_scores
boolean
default:"false"
Output the raw reranker score or the normalized score between 0-1. When false, score is between 0 and 1, otherwise range is indeterminate
​
return_text
boolean
default:"false"
Return the text with along with each rank
​
truncate
boolean
default:"false"
Automatically truncate inputs that are longer than the maximum supported size
​
truncate_direction
"right" | "left"
default:"right"