GET
/
v1
/
data-stores
/
search
curl --request GET \
  --url https://api.eqho.ai/v1/data-stores/search \
  --header 'X-API-KEY: <api-key>'
[
  {
    "content": "<string>",
    "source": "<string>"
  }
]

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
data_store_id
string
required

The unique identifier for the Knowledge Base which is given by Eqho.

Examples:

"6793d444709df162092367a9"

​
query
string
required

The text to match against the documents in the Knowledge Base.

​
search_type
enum<string>

The type of search to perform.

similarity: Search for documents similar to the query text. similarity_score_threshold: Search for documents with similarity scores above a threshold. mmr: Search for documents using Maximal Marginal Relevance.

Available options:
similarity,
similarity_score_threshold,
mmr
​
num_results
integer
default:2

The number of found documents to return.

Required range: 1 <= x <= 100
​
score_threshold
number
default:0.8

The similarity score threshold for similarity_score_threshold search.

Required range: 0 <= x <= 1
​
mmr_num_docs
integer
default:20

The number of documents to be used in the MMR search algorithm. Lower values will return less diverse documents.

Used only when search_type is 'mmr'.

Required range: 2 <= x <= 200
​
mmr_doc_diversity
number
default:0.5

The desired diversity of the documents returned by MMR search.

Used only when search_type is 'mmr'.

Required range: 0 <= x <= 1

Response

200
application/json
Successful Response

Response model for data store queries