Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::SearchDataObjectsRequest (v0.1.0)

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::SearchDataObjectsRequest.

Request for performing a single search.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — 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.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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.

#page_token

def page_token() -> ::String

Returns

• (::String) — Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

Returns

• (::String) — Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

#parent

def parent() -> ::String

Returns

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

#parent=

def parent=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

Returns

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

#semantic_search

def semantic_search() -> ::Google::Cloud::VectorSearch::V1::SemanticSearch

Returns

• (::Google::Cloud::VectorSearch::V1::SemanticSearch) — A semantic search operation.

  Note: The following fields are mutually exclusive: semantic_search, vector_search, text_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#semantic_search=

def semantic_search=(value) -> ::Google::Cloud::VectorSearch::V1::SemanticSearch

Parameter

• value (::Google::Cloud::VectorSearch::V1::SemanticSearch) — A semantic search operation.

  Note: The following fields are mutually exclusive: semantic_search, vector_search, text_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::VectorSearch::V1::SemanticSearch) — A semantic search operation.

  Note: The following fields are mutually exclusive: semantic_search, vector_search, text_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_search

def text_search() -> ::Google::Cloud::VectorSearch::V1::TextSearch

Returns

• (::Google::Cloud::VectorSearch::V1::TextSearch) — Optional. A text search operation.

  Note: The following fields are mutually exclusive: text_search, vector_search, semantic_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text_search=

def text_search=(value) -> ::Google::Cloud::VectorSearch::V1::TextSearch

Parameter

• value (::Google::Cloud::VectorSearch::V1::TextSearch) — Optional. A text search operation.

  Note: The following fields are mutually exclusive: text_search, vector_search, semantic_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::VectorSearch::V1::TextSearch) — Optional. A text search operation.

  Note: The following fields are mutually exclusive: text_search, vector_search, semantic_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vector_search

def vector_search() -> ::Google::Cloud::VectorSearch::V1::VectorSearch

Returns

• (::Google::Cloud::VectorSearch::V1::VectorSearch) — A vector search operation.

  Note: The following fields are mutually exclusive: vector_search, semantic_search, text_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vector_search=

def vector_search=(value) -> ::Google::Cloud::VectorSearch::V1::VectorSearch

Parameter

• value (::Google::Cloud::VectorSearch::V1::VectorSearch) — A vector search operation.

  Note: The following fields are mutually exclusive: vector_search, semantic_search, text_search. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::VectorSearch::V1::VectorSearch) — A vector search operation.

  Note: The following fields are mutually exclusive: vector_search, semantic_search, text_search. If a field in that set is populated, all other fields in the set will automatically be cleared.