Reference documentation and code samples for the Google Cloud Vector Search V1 Client class SearchDataObjectsRequest.
Request for performing a single search.
Generated from protobuf message google.cloud.vectorsearch.v1.SearchDataObjectsRequest
Namespace
Google \ Cloud \ VectorSearch \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ vector_search |
VectorSearch
A vector search operation. |
↳ semantic_search |
SemanticSearch
A semantic search operation. |
↳ text_search |
TextSearch
Optional. A text search operation. |
↳ parent |
string
Required. The resource name of the Collection for which to search. Format: |
↳ page_size |
int
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 |
string
Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call. |
getVectorSearch
A vector search operation.
| Returns | |
|---|---|
| Type | Description |
VectorSearch|null |
|
hasVectorSearch
setVectorSearch
A vector search operation.
| Parameter | |
|---|---|
| Name | Description |
var |
VectorSearch
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSemanticSearch
A semantic search operation.
| Returns | |
|---|---|
| Type | Description |
SemanticSearch|null |
|
hasSemanticSearch
setSemanticSearch
A semantic search operation.
| Parameter | |
|---|---|
| Name | Description |
var |
SemanticSearch
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTextSearch
Optional. A text search operation.
| Returns | |
|---|---|
| Type | Description |
TextSearch|null |
|
hasTextSearch
setTextSearch
Optional. A text search operation.
| Parameter | |
|---|---|
| Name | Description |
var |
TextSearch
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParent
Required. The resource name of the Collection for which to search.
Format: projects/{project}/locations/{location}/collections/{collection}
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The resource name of the Collection for which to search.
Format: projects/{project}/locations/{location}/collections/{collection}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
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 | |
|---|---|
| Type | Description |
int |
|
setPageSize
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. The standard list page token.
Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. The standard list page token.
Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSearchType
| Returns | |
|---|---|
| Type | Description |
string |
|