Skip to content
Factflow

Semantic Search

POST
/api/v1/search

Execute semantic similarity search.

Args: request: Search request with query vector and parameters service: Search service (injected)

Returns: Search results with similarity scores

Raises: HTTPException: 400 for invalid request, 500 for server errors

Request Body required

Section titled “Request Body required ”
SearchRequestModel

API request model for semantic search.

object
query_vector
required
Query Vector

Pre-computed query embedding vector

Array<number>
>= 1 items
model_name
required
Model Name

Name of the embedding model

string
>= 1 characters
limit
Limit

Maximum number of results

integer
default: 10 >= 1 <= 100
similarity_threshold
Any of:
number
<= 1
include_content
Include Content

Include segment content in results

boolean
offset
Offset

Pagination offset

integer
0
metadata_filters
Any of:
object
key
additional properties
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

SearchResponseModel

API response model for search results.

object
results
required
Results
Array<object>
SearchResultModel

API model for a single search result.

object
vector_id
required
Vector Id
string format: uuid
segment_id
required
Segment Id
string format: uuid
model_name
required
Model Name
string
similarity
required
Similarity
number
<= 1
storage_key
Any of:
string
content
Any of:
string
metadata
Any of:
object
key
additional properties
Any of:
string
total_count
required
Total Count
integer
limit
required
Limit
integer
>= 1
offset
required
Offset
integer
model_name
required
Model Name
string
search_time_ms
required
Search Time Ms
number
index_used
required
Index Used
boolean

422

Section titled “422 ”

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