Vector Search v1 API - Class SearchDataObjectsRequest (1.0.0-beta01) 

public sealed class SearchDataObjectsRequest : IMessage<SearchDataObjectsRequest>, IEquatable<SearchDataObjectsRequest>, IDeepCloneable<SearchDataObjectsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Vector Search v1 API class SearchDataObjectsRequest.

Request for performing a single search.

Inheritance

object > SearchDataObjectsRequest

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

SearchDataObjectsRequest()

public SearchDataObjectsRequest()

SearchDataObjectsRequest(SearchDataObjectsRequest)

public SearchDataObjectsRequest(SearchDataObjectsRequest other)
Parameter
Name Description
other SearchDataObjectsRequest

Properties

PageSize

public int PageSize { get; set; }

Optional. The standard list page size. Only supported for KNN. If not set, up to search_type.top_k results will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

Optional. The standard list page token. Typically obtained via [SearchDataObjectsResponse.next_page_token][google.cloud.vectorsearch.v1.SearchDataObjectsResponse.next_page_token] of the previous [DataObjectSearchService.SearchDataObjects][google.cloud.vectorsearch.v1.DataObjectSearchService.SearchDataObjects] call.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

Property Value
Type Description
string

ParentAsCollectionName

public CollectionName ParentAsCollectionName { get; set; }

CollectionName-typed view over the Parent resource name property.

Property Value
Type Description
CollectionName

SearchTypeCase

public SearchDataObjectsRequest.SearchTypeOneofCase SearchTypeCase { get; }
Property Value
Type Description
SearchDataObjectsRequestSearchTypeOneofCase

SemanticSearch

public SemanticSearch SemanticSearch { get; set; }

A semantic search operation.

Property Value
Type Description
SemanticSearch

TextSearch

public TextSearch TextSearch { get; set; }

Optional. A text search operation.

Property Value
Type Description
TextSearch

VectorSearch

public VectorSearch VectorSearch { get; set; }

A vector search operation.

Property Value
Type Description
VectorSearch