Class SearchRequest

Represents a search query and/or vector search to execute via the Couchbase Full Text Search (FTS) service.

Index

Constructors

Methods

withSearchQuery withVectorSearch create

Constructors

constructor

new SearchRequest(query: SearchQuery | VectorSearch): SearchRequest
Parameters
- query: SearchQuery | VectorSearch
Returns SearchRequest
- Defined in lib/searchtypes.ts:197

Methods

withSearchQuery

withSearchQuery(query: SearchQuery): SearchRequest
Adds a search query to the request if the request does not already have a search query.
Parameters
- query: SearchQuery
  A SearchQuery to add to the request.
Returns SearchRequest
- Defined in lib/searchtypes.ts:230

withVectorSearch

withVectorSearch(search: VectorSearch): SearchRequest
Adds a vector search to the request if the request does not already have a vector search.
Parameters
- search: VectorSearch
  A VectorSearch to add to the request.
Returns SearchRequest
- Defined in lib/searchtypes.ts:248

`Static`create

create(query: SearchQuery | VectorSearch): SearchRequest
Creates a search request.
Parameters
- query: SearchQuery | VectorSearch
  Either a SearchQuery or VectorSearch to add to the search request.
Returns SearchRequest
- Defined in lib/searchtypes.ts:266