public static final class AskContextsRequest.Builder extends GeneratedMessage.Builder<AskContextsRequest.Builder> implements AskContextsRequestOrBuilderAgentic Retrieval Ask API for RAG. Request message for VertexRagService.AskContexts.
Protobuf type google.cloud.aiplatform.v1beta1.AskContextsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AskContextsRequest.BuilderImplements
AskContextsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllTools(Iterable<? extends Tool> values)
public AskContextsRequest.Builder addAllTools(Iterable<? extends Tool> values)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.aiplatform.v1beta1.Tool> |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
addTools(Tool value)
public AskContextsRequest.Builder addTools(Tool value)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Tool |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
addTools(Tool.Builder builderForValue)
public AskContextsRequest.Builder addTools(Tool.Builder builderForValue)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Tool.Builder |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
addTools(int index, Tool value)
public AskContextsRequest.Builder addTools(int index, Tool value)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Tool |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
addTools(int index, Tool.Builder builderForValue)
public AskContextsRequest.Builder addTools(int index, Tool.Builder builderForValue)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Tool.Builder |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
addToolsBuilder()
public Tool.Builder addToolsBuilder()Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Tool.Builder |
|
addToolsBuilder(int index)
public Tool.Builder addToolsBuilder(int index)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Tool.Builder |
|
build()
public AskContextsRequest build()| Returns | |
|---|---|
| Type | Description |
AskContextsRequest |
|
buildPartial()
public AskContextsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
AskContextsRequest |
|
clear()
public AskContextsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
clearParent()
public AskContextsRequest.Builder clearParent() Required. The resource name of the Location from which to retrieve
RagContexts. The users must have permission to make a call in the project.
Format:
projects/{project}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
This builder for chaining. |
clearQuery()
public AskContextsRequest.Builder clearQuery()Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
clearTools()
public AskContextsRequest.Builder clearTools()Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
getDefaultInstanceForType()
public AskContextsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AskContextsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getParent()
public String getParent() Required. The resource name of the Location from which to retrieve
RagContexts. The users must have permission to make a call in the project.
Format:
projects/{project}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public ByteString getParentBytes() Required. The resource name of the Location from which to retrieve
RagContexts. The users must have permission to make a call in the project.
Format:
projects/{project}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getQuery()
public RagQuery getQuery()Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
RagQuery |
The query. |
getQueryBuilder()
public RagQuery.Builder getQueryBuilder()Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
RagQuery.Builder |
|
getQueryOrBuilder()
public RagQueryOrBuilder getQueryOrBuilder()Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
RagQueryOrBuilder |
|
getTools(int index)
public Tool getTools(int index)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Tool |
|
getToolsBuilder(int index)
public Tool.Builder getToolsBuilder(int index)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Tool.Builder |
|
getToolsBuilderList()
public List<Tool.Builder> getToolsBuilderList()Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getToolsCount()
public int getToolsCount()Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getToolsList()
public List<Tool> getToolsList()Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Tool> |
|
getToolsOrBuilder(int index)
public ToolOrBuilder getToolsOrBuilder(int index)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ToolOrBuilder |
|
getToolsOrBuilderList()
public List<? extends ToolOrBuilder> getToolsOrBuilderList()Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.ToolOrBuilder> |
|
hasQuery()
public boolean hasQuery()Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the query field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(AskContextsRequest other)
public AskContextsRequest.Builder mergeFrom(AskContextsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
AskContextsRequest |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AskContextsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AskContextsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
mergeQuery(RagQuery value)
public AskContextsRequest.Builder mergeQuery(RagQuery value)Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
RagQuery |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
removeTools(int index)
public AskContextsRequest.Builder removeTools(int index)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
setParent(String value)
public AskContextsRequest.Builder setParent(String value) Required. The resource name of the Location from which to retrieve
RagContexts. The users must have permission to make a call in the project.
Format:
projects/{project}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public AskContextsRequest.Builder setParentBytes(ByteString value) Required. The resource name of the Location from which to retrieve
RagContexts. The users must have permission to make a call in the project.
Format:
projects/{project}/locations/{location}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
This builder for chaining. |
setQuery(RagQuery value)
public AskContextsRequest.Builder setQuery(RagQuery value)Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
RagQuery |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
setQuery(RagQuery.Builder builderForValue)
public AskContextsRequest.Builder setQuery(RagQuery.Builder builderForValue)Required. Single RAG retrieve query.
.google.cloud.aiplatform.v1beta1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RagQuery.Builder |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
setTools(int index, Tool value)
public AskContextsRequest.Builder setTools(int index, Tool value)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Tool |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|
setTools(int index, Tool.Builder builderForValue)
public AskContextsRequest.Builder setTools(int index, Tool.Builder builderForValue)Optional. The tools to use for AskContexts.
repeated .google.cloud.aiplatform.v1beta1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Tool.Builder |
| Returns | |
|---|---|
| Type | Description |
AskContextsRequest.Builder |
|