public static final class FunctionResponse.Builder extends GeneratedMessageV3.Builder<FunctionResponse.Builder> implements FunctionResponseOrBuilder
The result output from a [FunctionCall] that contains a string representing
the [FunctionDeclaration.name] and a structured JSON object containing any
output from the function is used as context to the model. This should contain
the result of a [FunctionCall] made based on model prediction.
Protobuf type google.cloud.aiplatform.v1.FunctionResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public FunctionResponse.Builder addAllParts(Iterable<? extends FunctionResponsePart> values)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1.FunctionResponsePart>
|
public FunctionResponse.Builder addParts(FunctionResponsePart value)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponse.Builder addParts(FunctionResponsePart.Builder builderForValue)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponse.Builder addParts(int index, FunctionResponsePart value)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponse.Builder addParts(int index, FunctionResponsePart.Builder builderForValue)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponsePart.Builder addPartsBuilder()
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponsePart.Builder addPartsBuilder(int index)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public FunctionResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public FunctionResponse build()
public FunctionResponse buildPartial()
public FunctionResponse.Builder clear()
Overrides
public FunctionResponse.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public FunctionResponse.Builder clearName()
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
public FunctionResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public FunctionResponse.Builder clearParts()
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponse.Builder clearResponse()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
public FunctionResponse.Builder clone()
Overrides
public FunctionResponse getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public FunctionResponsePart getParts(int index)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public FunctionResponsePart.Builder getPartsBuilder(int index)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<FunctionResponsePart.Builder> getPartsBuilderList()
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public int getPartsCount()
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public List<FunctionResponsePart> getPartsList()
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponsePartOrBuilder getPartsOrBuilder(int index)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends FunctionResponsePartOrBuilder> getPartsOrBuilderList()
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1.FunctionResponsePartOrBuilder> |
|
public Struct getResponse()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Struct |
The response.
|
public Struct.Builder getResponseBuilder()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
public StructOrBuilder getResponseOrBuilder()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
public boolean hasResponse()
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the response field is set.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FunctionResponse.Builder mergeFrom(FunctionResponse other)
public FunctionResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public FunctionResponse.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public FunctionResponse.Builder mergeResponse(Struct value)
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
Struct
|
public final FunctionResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
public FunctionResponse.Builder removeParts(int index)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
|
public FunctionResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public FunctionResponse.Builder setName(String value)
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
String
The name to set.
|
public FunctionResponse.Builder setNameBytes(ByteString value)
Required. The name of the function to call.
Matches [FunctionDeclaration.name] and [FunctionCall.name].
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for name to set.
|
public FunctionResponse.Builder setParts(int index, FunctionResponsePart value)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponse.Builder setParts(int index, FunctionResponsePart.Builder builderForValue)
Optional. Ordered Parts that constitute a function response. Parts may
have different IANA MIME types.
repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
public FunctionResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
public FunctionResponse.Builder setResponse(Struct value)
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
value |
Struct
|
public FunctionResponse.Builder setResponse(Struct.Builder builderForValue)
Required. The function response in JSON object format.
Use "output" key to specify function output and "error" key to specify
error details (if any). If "output" and "error" keys are not specified,
then whole "response" is treated as function output.
.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
builderForValue |
Builder
|
public final FunctionResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
