Send feedback
Class ToolUseExample (3.56.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.56.0 keyboard_arrow_down
public final class ToolUseExample extends GeneratedMessageV3 implements ToolUseExampleOrBuilder
A single example of the tool usage.
Protobuf type google.cloud.aiplatform.v1beta1.ToolUseExample
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 DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int EXTENSION_OPERATION_FIELD_NUMBER
Field Value
Type Description
int
public static final int FUNCTION_NAME_FIELD_NUMBER
Field Value
Type Description
int
public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int
public static final int REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int
public static final int RESPONSE_PARAMS_FIELD_NUMBER
Field Value
Type Description
int
public static final int RESPONSE_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
public static ToolUseExample getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static ToolUseExample . Builder newBuilder ()
public static ToolUseExample . Builder newBuilder ( ToolUseExample prototype )
public static ToolUseExample parseDelimitedFrom ( InputStream input )
public static ToolUseExample parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static ToolUseExample parseFrom ( byte [] data )
Parameter
Name Description
databyte []
public static ToolUseExample parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static ToolUseExample parseFrom ( ByteString data )
public static ToolUseExample parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ToolUseExample parseFrom ( CodedInputStream input )
public static ToolUseExample parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ToolUseExample parseFrom ( InputStream input )
public static ToolUseExample parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static ToolUseExample parseFrom ( ByteBuffer data )
public static ToolUseExample parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<ToolUseExample> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
public ToolUseExample getDefaultInstanceForType ()
public String getDisplayName ()
Required. The display name for example.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The displayName.
public ByteString getDisplayNameBytes ()
Required. The display name for example.
string display_name = 1 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for displayName.
getExtensionOperation()
public ToolUseExample . ExtensionOperation getExtensionOperation ()
Extension operation to call.
.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;
getExtensionOperationOrBuilder()
public ToolUseExample . ExtensionOperationOrBuilder getExtensionOperationOrBuilder ()
Extension operation to call.
.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;
public String getFunctionName ()
Function name to call.
string function_name = 11;
Returns
Type Description
String The functionName.
public ByteString getFunctionNameBytes ()
Function name to call.
string function_name = 11;
Returns
Type Description
ByteString The bytes for functionName.
public Parser<ToolUseExample> getParserForType ()
Overrides
Required. Query that should be routed to this tool.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The query.
public ByteString getQueryBytes ()
Required. Query that should be routed to this tool.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for query.
public Struct getRequestParams ()
Request parameters used for executing this tool.
.google.protobuf.Struct request_params = 3;
Returns
Type Description
Struct The requestParams.
public StructOrBuilder getRequestParamsOrBuilder ()
Request parameters used for executing this tool.
.google.protobuf.Struct request_params = 3;
public Struct getResponseParams ()
Response parameters generated by this tool.
.google.protobuf.Struct response_params = 4;
Returns
Type Description
Struct The responseParams.
public StructOrBuilder getResponseParamsOrBuilder ()
Response parameters generated by this tool.
.google.protobuf.Struct response_params = 4;
public String getResponseSummary ()
Summary of the tool response to the user query.
string response_summary = 5;
Returns
Type Description
String The responseSummary.
public ByteString getResponseSummaryBytes ()
Summary of the tool response to the user query.
string response_summary = 5;
Returns
Type Description
ByteString The bytes for responseSummary.
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public ToolUseExample . TargetCase getTargetCase ()
public boolean hasExtensionOperation ()
Extension operation to call.
.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;
Returns
Type Description
boolean Whether the extensionOperation field is set.
public boolean hasFunctionName ()
Function name to call.
string function_name = 11;
Returns
Type Description
boolean Whether the functionName field is set.
public boolean hasRequestParams ()
Request parameters used for executing this tool.
.google.protobuf.Struct request_params = 3;
Returns
Type Description
boolean Whether the requestParams field is set.
public boolean hasResponseParams ()
Response parameters generated by this tool.
.google.protobuf.Struct response_params = 4;
Returns
Type Description
boolean Whether the responseParams field is set.
Returns
Type Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public ToolUseExample . Builder newBuilderForType ()
protected ToolUseExample . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
public ToolUseExample . Builder toBuilder ()
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-01-27 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-01-27 UTC."],[],[]]
