Class SearchRequest

A top-level SearchRequest, encompassing all Search sub-request types, including FTS and VectorSearch.

Inheritance
object
SearchRequest
Implements
Inherited Members
Namespace: Couchbase.Search
Assembly: Couchbase.NetClient.dll
Syntax
[InterfaceStability(Level.Committed)]
public sealed record SearchRequest : IEquatable<SearchRequest>

Constructors

| Edit this page View Source

SearchRequest(ISearchQuery?, VectorSearch?)

A top-level SearchRequest, encompassing all Search sub-request types, including FTS and VectorSearch.

Declaration
public SearchRequest(ISearchQuery? SearchQuery = null, VectorSearch? VectorSearch = null)
Parameters
Type Name Description
ISearchQuery SearchQuery
VectorSearch VectorSearch

Properties

| Edit this page View Source

Scope

Declaration
public IScope? Scope { get; init; }
Property Value
Type Description
IScope
| Edit this page View Source

SearchQuery

Declaration
public ISearchQuery? SearchQuery { get; init; }
Property Value
Type Description
ISearchQuery
| Edit this page View Source

VectorSearch

Declaration
public VectorSearch? VectorSearch { get; init; }
Property Value
Type Description
VectorSearch

Methods

| Edit this page View Source

Create(ISearchQuery)

Declaration
public static SearchRequest Create(ISearchQuery searchQuery)
Parameters
Type Name Description
ISearchQuery searchQuery
Returns
Type Description
SearchRequest
| Edit this page View Source

Create(VectorSearch)

Declaration
public static SearchRequest Create(VectorSearch vectorSearch)
Parameters
Type Name Description
VectorSearch vectorSearch
Returns
Type Description
SearchRequest
| Edit this page View Source

WithSearchQuery(ISearchQuery)

Declaration
public SearchRequest WithSearchQuery(ISearchQuery searchQuery)
Parameters
Type Name Description
ISearchQuery searchQuery
Returns
Type Description
SearchRequest
| Edit this page View Source

WithVectorSearch(VectorSearch)

Declaration
public SearchRequest WithVectorSearch(VectorSearch vectorSearch)
Parameters
Type Name Description
VectorSearch vectorSearch
Returns
Type Description
SearchRequest

Implements