Skip to content

Semantic Search

POST
/api/data/chromadb/search

Perform semantic search on a ChromaDB collection.

SemanticSearchRequest
object
collection
required
Collection

Collection name to search

string
query
required
Query

Natural-language search query

string
n_results
N Results

Max results

integer
default: 5 >= 1 <= 100
threshold
Threshold

Similarity threshold

number
default: 0.5 <= 1

Successful Response

SemanticSearchResponse
object
results
required
Results
Array<object>
SearchResultItem
object
id
required
Id
string
document
Any of:
string
metadata
Metadata
object
key
additional properties
any
distance
Any of:
number
total
required
Total
integer
collection
required
Collection
string
query
required
Query
string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object