- 0.74.0 (latest)
 - 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 interface GenerateGroundedContentRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsUserLabels(String key)
public abstract boolean containsUserLabels(String key)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
 - Each label must be a key-value pair.
 - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
 - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
 - The key portion of a label must be unique. However, you can use the same key with multiple resources.
 Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
 map<string, string> user_labels = 6;
| Parameter | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
getContents(int index)
public abstract GroundedGenerationContent getContents(int index)Content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
Only a single-turn query is supported currently.
 repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
GroundedGenerationContent | 
        |
getContentsCount()
public abstract int getContentsCount()Content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
Only a single-turn query is supported currently.
 repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getContentsList()
public abstract List<GroundedGenerationContent> getContentsList()Content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
Only a single-turn query is supported currently.
 repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Returns | |
|---|---|
| Type | Description | 
List<GroundedGenerationContent> | 
        |
getContentsOrBuilder(int index)
public abstract GroundedGenerationContentOrBuilder getContentsOrBuilder(int index)Content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
Only a single-turn query is supported currently.
 repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Parameter | |
|---|---|
| Name | Description | 
index | 
        int | 
      
| Returns | |
|---|---|
| Type | Description | 
GroundedGenerationContentOrBuilder | 
        |
getContentsOrBuilderList()
public abstract List<? extends GroundedGenerationContentOrBuilder> getContentsOrBuilderList()Content of the current conversation with the model.
For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
Only a single-turn query is supported currently.
 repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Returns | |
|---|---|
| Type | Description | 
List<? extends com.google.cloud.discoveryengine.v1.GroundedGenerationContentOrBuilder> | 
        |
getGenerationSpec()
public abstract GenerateGroundedContentRequest.GenerationSpec getGenerationSpec()Content generation specification.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
 
| Returns | |
|---|---|
| Type | Description | 
GenerateGroundedContentRequest.GenerationSpec | 
        The generationSpec.  | 
      
getGenerationSpecOrBuilder()
public abstract GenerateGroundedContentRequest.GenerationSpecOrBuilder getGenerationSpecOrBuilder()Content generation specification.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
 
| Returns | |
|---|---|
| Type | Description | 
GenerateGroundedContentRequest.GenerationSpecOrBuilder | 
        |
getGroundingSpec()
public abstract GenerateGroundedContentRequest.GroundingSpec getGroundingSpec()Grounding specification.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
 
| Returns | |
|---|---|
| Type | Description | 
GenerateGroundedContentRequest.GroundingSpec | 
        The groundingSpec.  | 
      
getGroundingSpecOrBuilder()
public abstract GenerateGroundedContentRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()Grounding specification.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
 
| Returns | |
|---|---|
| Type | Description | 
GenerateGroundedContentRequest.GroundingSpecOrBuilder | 
        |
getLocation()
public abstract String getLocation()Required. Location resource.
 Format: projects/{project}/locations/{location}.
 
 string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
String | 
        The location.  | 
      
getLocationBytes()
public abstract ByteString getLocationBytes()Required. Location resource.
 Format: projects/{project}/locations/{location}.
 
 string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for location.  | 
      
getSystemInstruction()
public abstract GroundedGenerationContent getSystemInstruction()Content of the system instruction for the current API.
These instructions will take priority over any other prompt instructions if the selected model is supporting them.
 .google.cloud.discoveryengine.v1.GroundedGenerationContent system_instruction = 5;
| Returns | |
|---|---|
| Type | Description | 
GroundedGenerationContent | 
        The systemInstruction.  | 
      
getSystemInstructionOrBuilder()
public abstract GroundedGenerationContentOrBuilder getSystemInstructionOrBuilder()Content of the system instruction for the current API.
These instructions will take priority over any other prompt instructions if the selected model is supporting them.
 .google.cloud.discoveryengine.v1.GroundedGenerationContent system_instruction = 5;
| Returns | |
|---|---|
| Type | Description | 
GroundedGenerationContentOrBuilder | 
        |
getUserLabels() (deprecated)
public abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description | 
Map<String,String> | 
        |
getUserLabelsCount()
public abstract int getUserLabelsCount()The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
 - Each label must be a key-value pair.
 - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
 - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
 - The key portion of a label must be unique. However, you can use the same key with multiple resources.
 Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
 map<string, string> user_labels = 6;
| Returns | |
|---|---|
| Type | Description | 
int | 
        |
getUserLabelsMap()
public abstract Map<String,String> getUserLabelsMap()The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
 - Each label must be a key-value pair.
 - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
 - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
 - The key portion of a label must be unique. However, you can use the same key with multiple resources.
 Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
 map<string, string> user_labels = 6;
| Returns | |
|---|---|
| Type | Description | 
Map<String,String> | 
        |
getUserLabelsOrDefault(String key, String defaultValue)
public abstract String getUserLabelsOrDefault(String key, String defaultValue)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
 - Each label must be a key-value pair.
 - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
 - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
 - The key portion of a label must be unique. However, you can use the same key with multiple resources.
 Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
 map<string, string> user_labels = 6;
| Parameters | |
|---|---|
| Name | Description | 
key | 
        String | 
      
defaultValue | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
String | 
        |
getUserLabelsOrThrow(String key)
public abstract String getUserLabelsOrThrow(String key)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
 - Each label must be a key-value pair.
 - Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
 - Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
 - The key portion of a label must be unique. However, you can use the same key with multiple resources.
 Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
 map<string, string> user_labels = 6;
| Parameter | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
String | 
        |
hasGenerationSpec()
public abstract boolean hasGenerationSpec()Content generation specification.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the generationSpec field is set.  | 
      
hasGroundingSpec()
public abstract boolean hasGroundingSpec()Grounding specification.
 
 .google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the groundingSpec field is set.  | 
      
hasSystemInstruction()
public abstract boolean hasSystemInstruction()Content of the system instruction for the current API.
These instructions will take priority over any other prompt instructions if the selected model is supporting them.
 .google.cloud.discoveryengine.v1.GroundedGenerationContent system_instruction = 5;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the systemInstruction field is set.  |