SearchService gRPC API

SearchService provides full-text search over indexed documents. Provider plugin (qntx-meili) registers as the backend. Core routes calls to the provider.

Proto file: plugin/grpc/protocol/search.proto

Service Methods

Method	Request	Response	Streaming
Search	SearchRequest	SearchResponse	No
IndexDocuments	IndexDocumentsRequest	IndexDocumentsResponse	No
DeleteDocuments	DeleteDocumentsRequest	DeleteDocumentsResponse	No
ConfigureIndex	ConfigureIndexRequest	ConfigureIndexResponse	No

Search

Request: SearchRequest
Response: SearchResponse

IndexDocuments

Request: IndexDocumentsRequest
Response: IndexDocumentsResponse

DeleteDocuments

Request: DeleteDocumentsRequest
Response: DeleteDocumentsResponse

ConfigureIndex

Request: ConfigureIndexRequest
Response: ConfigureIndexResponse

Message Types

SearchRequest

Field	Type	Description
query	string	-
index	string	-
top_k	int32	-
filters	bytes	-
facets	string	-

SearchResponse

Field	Type	Description
hits	SearchHit	-
total	int32	-
processing_ms	int32	-
facet_distribution	bytes	-

SearchHit

Field	Type	Description
id	string	-
score	float	-
document	bytes	-
highlighted	bytes	-

IndexDocumentsRequest

Field	Type	Description
index	string	-
documents	bytes	-

IndexDocumentsResponse

Field	Type	Description
accepted	int32	-

DeleteDocumentsRequest

Field	Type	Description
index	string	-
ids	string	-

DeleteDocumentsResponse

Field	Type	Description
deleted	int32	-

ConfigureIndexRequest

Field	Type	Description
index	string	-
primary_key	string	-
filterable_attributes	string	-
sortable_attributes	string	-
searchable_attributes	string	-

ConfigureIndexResponse

Field	Type	Description
accepted	bool	-

← Back to API Index