- 0.79.0 (latest)
- 0.78.0
- 0.77.0
- 0.76.0
- 0.74.0
- 0.72.0
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder extends GeneratedMessage.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder> implements GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilderMessage to be used for grounding with Vertex AI Search.
Protobuf type
google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > GenerateGroundedContentRequest.GroundingSource.SearchSource.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public GenerateGroundedContentRequest.GroundingSource.SearchSource build()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource |
|
buildPartial()
public GenerateGroundedContentRequest.GroundingSource.SearchSource buildPartial()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource |
|
clear()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clear()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
|
clearFilter()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearFilter()Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
string filter = 3;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
clearMaxResultCount()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearMaxResultCount()Number of search results to return.
The default value is 10. The maximumm allowed value is 10.
int32 max_result_count = 2;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
clearSafeSearch()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearSafeSearch()If set, safe search is enabled in Vertex AI Search requests.
bool safe_search = 5;
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
clearServingConfig()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearServingConfig()The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
string filter = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
string filter = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getMaxResultCount()
public int getMaxResultCount()Number of search results to return.
The default value is 10. The maximumm allowed value is 10.
int32 max_result_count = 2;
| Returns | |
|---|---|
| Type | Description |
int |
The maxResultCount. |
getSafeSearch()
public boolean getSafeSearch()If set, safe search is enabled in Vertex AI Search requests.
bool safe_search = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
The safeSearch. |
getServingConfig()
public String getServingConfig()The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The servingConfig. |
getServingConfigBytes()
public ByteString getServingConfigBytes()The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for servingConfig. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GenerateGroundedContentRequest.GroundingSource.SearchSource other)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(GenerateGroundedContentRequest.GroundingSource.SearchSource other)| Parameter | |
|---|---|
| Name | Description |
other |
GenerateGroundedContentRequest.GroundingSource.SearchSource |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
|
setFilter(String value)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setFilter(String value)Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
string filter = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setFilterBytes(ByteString value)Filter expression to be applied to the search.
The syntax is the same as SearchRequest.filter.
string filter = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
setMaxResultCount(int value)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setMaxResultCount(int value)Number of search results to return.
The default value is 10. The maximumm allowed value is 10.
int32 max_result_count = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe maxResultCount to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
setSafeSearch(boolean value)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setSafeSearch(boolean value)If set, safe search is enabled in Vertex AI Search requests.
bool safe_search = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe safeSearch to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
setServingConfig(String value)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setServingConfig(String value)The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe servingConfig to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |
setServingConfigBytes(ByteString value)
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setServingConfigBytes(ByteString value)The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for servingConfig to set. |
| Returns | |
|---|---|
| Type | Description |
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder |
This builder for chaining. |