Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SearchSource.
Message to be used for grounding with Vertex AI Search.
Generated from protobuf message google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ GenerateGroundedContentRequest \ GroundingSourceMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ serving_config |
string
The resource name of the Engine to use. Format: |
↳ max_result_count |
int
Number of search results to return. The default value is 10. The maximumm allowed value is 10. |
↳ filter |
string
Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter. |
↳ safe_search |
bool
If set, safe search is enabled in Vertex AI Search requests. |
getServingConfig
The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setServingConfig
The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxResultCount
Number of search results to return.
The default value is 10. The maximumm allowed value is 10.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxResultCount
Number of search results to return.
The default value is 10. The maximumm allowed value is 10.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSafeSearch
If set, safe search is enabled in Vertex AI Search requests.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSafeSearch
If set, safe search is enabled in Vertex AI Search requests.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|