Send feedback
Class FunctionResponse (1.20.0)
Stay organized with collections
Save and categorize content based on your preferences.
public final class FunctionResponse extends GeneratedMessageV3 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.vertexai.v1.FunctionResponse
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
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
RESPONSE_FIELD_NUMBER
public static final int RESPONSE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static FunctionResponse getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static FunctionResponse . Builder newBuilder ()
newBuilder(FunctionResponse prototype)
public static FunctionResponse . Builder newBuilder ( FunctionResponse prototype )
public static FunctionResponse parseDelimitedFrom ( InputStream input )
public static FunctionResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static FunctionResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FunctionResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static FunctionResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FunctionResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static FunctionResponse parseFrom ( CodedInputStream input )
public static FunctionResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static FunctionResponse parseFrom ( InputStream input )
public static FunctionResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static FunctionResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FunctionResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<FunctionResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public FunctionResponse getDefaultInstanceForType ()
getName()
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.
getNameBytes()
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.
getParserForType()
public Parser<FunctionResponse> getParserForType ()
Overrides
getResponse()
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.
getResponseOrBuilder()
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];
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasResponse()
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public FunctionResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FunctionResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public FunctionResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-22 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-22 UTC."],[],[]]
