public final class GenerateGroundedContentRequest extends GeneratedMessageV3 implements GenerateGroundedContentRequestOrBuilder
Top-level message sent by the client for the GenerateGroundedContent
method.
Protobuf type google.cloud.discoveryengine.v1.GenerateGroundedContentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GENERATION_SPEC_FIELD_NUMBER
public static final int GENERATION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GROUNDING_SPEC_FIELD_NUMBER
public static final int GROUNDING_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SYSTEM_INSTRUCTION_FIELD_NUMBER
public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static GenerateGroundedContentRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GenerateGroundedContentRequest.Builder newBuilder()
newBuilder(GenerateGroundedContentRequest prototype)
public static GenerateGroundedContentRequest.Builder newBuilder(GenerateGroundedContentRequest prototype)
parseDelimitedFrom(InputStream input)
public static GenerateGroundedContentRequest parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GenerateGroundedContentRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GenerateGroundedContentRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static GenerateGroundedContentRequest parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static GenerateGroundedContentRequest parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GenerateGroundedContentRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GenerateGroundedContentRequest> parser()
Methods
containsUserLabels(String key)
public boolean containsUserLabels(String key)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 6;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getContents(int index)
public 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.
repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Parameter |
| Name |
Description |
index |
int
|
getContentsCount()
public 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.
repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Returns |
| Type |
Description |
int |
|
getContentsList()
public 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.
repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
getContentsOrBuilder(int index)
public 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.
repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Parameter |
| Name |
Description |
index |
int
|
getContentsOrBuilderList()
public 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.
repeated .google.cloud.discoveryengine.v1.GroundedGenerationContent contents = 2;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.discoveryengine.v1.GroundedGenerationContentOrBuilder> |
|
getDefaultInstanceForType()
public GenerateGroundedContentRequest getDefaultInstanceForType()
getGenerationSpec()
public GenerateGroundedContentRequest.GenerationSpec getGenerationSpec()
Content generation specification.
.google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
getGenerationSpecOrBuilder()
public GenerateGroundedContentRequest.GenerationSpecOrBuilder getGenerationSpecOrBuilder()
Content generation specification.
.google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec generation_spec = 3;
getGroundingSpec()
public GenerateGroundedContentRequest.GroundingSpec getGroundingSpec()
Grounding specification.
.google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
getGroundingSpecOrBuilder()
public GenerateGroundedContentRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()
Grounding specification.
.google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSpec grounding_spec = 4;
getLocation()
public 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 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.
|
getParserForType()
public Parser<GenerateGroundedContentRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSystemInstruction()
public 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;
getSystemInstructionOrBuilder()
public 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;
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()
getUserLabelsCount()
public int getUserLabelsCount()
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 6;
| Returns |
| Type |
Description |
int |
|
getUserLabelsMap()
public Map<String,String> getUserLabelsMap()
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 6;
getUserLabelsOrDefault(String key, String defaultValue)
public String getUserLabelsOrDefault(String key, String defaultValue)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 6;
| Returns |
| Type |
Description |
String |
|
getUserLabelsOrThrow(String key)
public String getUserLabelsOrThrow(String key)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 6;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
hasGenerationSpec()
public 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GenerateGroundedContentRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GenerateGroundedContentRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public GenerateGroundedContentRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
