Class FunctionResponse (3.36.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

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static FunctionResponse getDefaultInstance()
Returns
TypeDescription
FunctionResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static FunctionResponse.Builder newBuilder()
Returns
TypeDescription
FunctionResponse.Builder

newBuilder(FunctionResponse prototype)

public static FunctionResponse.Builder newBuilder(FunctionResponse prototype)
Parameter
NameDescription
prototypeFunctionResponse
Returns
TypeDescription
FunctionResponse.Builder

parseDelimitedFrom(InputStream input)

public static FunctionResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static FunctionResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunctionResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunctionResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunctionResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunctionResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static FunctionResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static FunctionResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunctionResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FunctionResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<FunctionResponse> parser()
Returns
TypeDescription
Parser<FunctionResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public FunctionResponse getDefaultInstanceForType()
Returns
TypeDescription
FunctionResponse

getName()

public String getName()

Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<FunctionResponse> getParserForType()
Returns
TypeDescription
Parser<FunctionResponse>
Overrides

getResponse()

public Struct getResponse()

Required. The function response in JSON object format.

.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Struct

The response.

getResponseOrBuilder()

public StructOrBuilder getResponseOrBuilder()

Required. The function response in JSON object format.

.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StructOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasResponse()

public boolean hasResponse()

Required. The function response in JSON object format.

.google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the response field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public FunctionResponse.Builder newBuilderForType()
Returns
TypeDescription
FunctionResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FunctionResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
FunctionResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public FunctionResponse.Builder toBuilder()
Returns
TypeDescription
FunctionResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException