Class FunctionResponse (3.77.0)
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.aiplatform.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
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FunctionResponse getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FunctionResponse.Builder newBuilder()
public static FunctionResponse.Builder newBuilder(FunctionResponse prototype)
public static FunctionResponse parseDelimitedFrom(InputStream input)
public static FunctionResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FunctionResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FunctionResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FunctionResponse parseFrom(ByteString data)
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)
public static FunctionResponse parseFrom(ByteBuffer data)
public static FunctionResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FunctionResponse> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public FunctionResponse getDefaultInstanceForType()
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 Parser<FunctionResponse> getParserForType()
Overrides
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 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 int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FunctionResponse.Builder newBuilderForType()
protected FunctionResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FunctionResponse.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
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-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
