Package com.google.cloud.aiplatform.v1

Class AskContextsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.AskContextsRequest
All Implemented Interfaces:
AskContextsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AskContextsRequest extends com.google.protobuf.GeneratedMessage implements AskContextsRequestOrBuilder
 Agentic Retrieval Ask API for RAG.
 Request message for
 [VertexRagService.AskContexts][google.cloud.aiplatform.v1.VertexRagService.AskContexts].
Protobuf type google.cloud.aiplatform.v1.AskContextsRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AskContextsRequest.Builder
    Agentic Retrieval Ask API for RAG.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    TOOLS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static AskContextsRequest
    getDefaultInstance()
     
    AskContextsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<AskContextsRequest>
    getParserForType()
     
    RagQuery
    getQuery()
    Required.
    RagQueryOrBuilder
    getQueryOrBuilder()
    Required.
    int
    getSerializedSize()
     
    Tool
    getTools(int index)
    Optional.
    int
    getToolsCount()
    Optional.
    List<Tool>
    getToolsList()
    Optional.
    ToolOrBuilder
    getToolsOrBuilder(int index)
    Optional.
    List<? extends ToolOrBuilder>
    getToolsOrBuilderList()
    Optional.
    int
    hashCode()
     
    boolean
    hasQuery()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static AskContextsRequest.Builder
    newBuilder()
     
    static AskContextsRequest.Builder
    newBuilder(AskContextsRequest prototype)
     
    AskContextsRequest.Builder
    newBuilderForType()
     
    protected AskContextsRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AskContextsRequest
    parseDelimitedFrom(InputStream input)
     
    static AskContextsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AskContextsRequest
    parseFrom(byte[] data)
     
    static AskContextsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AskContextsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static AskContextsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AskContextsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AskContextsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AskContextsRequest
    parseFrom(InputStream input)
     
    static AskContextsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AskContextsRequest
    parseFrom(ByteBuffer data)
     
    static AskContextsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AskContextsRequest>
    parser()
     
    AskContextsRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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) = { ... }
      Specified by:
      getParent in interface AskContextsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getParentBytes in interface AskContextsRequestOrBuilder
      Returns:
      The bytes for parent.

    • hasQuery

      public boolean hasQuery()
       Required. Single RAG retrieve query.
      .google.cloud.aiplatform.v1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuery in interface AskContextsRequestOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public RagQuery getQuery()
       Required. Single RAG retrieve query.
      .google.cloud.aiplatform.v1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface AskContextsRequestOrBuilder
      Returns:
      The query.

    • getQueryOrBuilder

      public RagQueryOrBuilder getQueryOrBuilder()
       Required. Single RAG retrieve query.
      .google.cloud.aiplatform.v1.RagQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryOrBuilder in interface AskContextsRequestOrBuilder

    • getToolsList

      public List<Tool> getToolsList()
       Optional. The tools to use for AskContexts.
      repeated .google.cloud.aiplatform.v1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsList in interface AskContextsRequestOrBuilder

    • getToolsOrBuilderList

      public List<? extends ToolOrBuilder> getToolsOrBuilderList()
       Optional. The tools to use for AskContexts.
      repeated .google.cloud.aiplatform.v1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsOrBuilderList in interface AskContextsRequestOrBuilder

    • getToolsCount

      public int getToolsCount()
       Optional. The tools to use for AskContexts.
      repeated .google.cloud.aiplatform.v1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsCount in interface AskContextsRequestOrBuilder

    • getTools

      public Tool getTools(int index)
       Optional. The tools to use for AskContexts.
      repeated .google.cloud.aiplatform.v1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTools in interface AskContextsRequestOrBuilder

    • getToolsOrBuilder

      public ToolOrBuilder getToolsOrBuilder(int index)
       Optional. The tools to use for AskContexts.
      repeated .google.cloud.aiplatform.v1.Tool tools = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsOrBuilder in interface AskContextsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AskContextsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AskContextsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AskContextsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AskContextsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AskContextsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AskContextsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AskContextsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AskContextsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AskContextsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AskContextsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AskContextsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AskContextsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AskContextsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AskContextsRequest.Builder newBuilder()

    • newBuilder

      public static AskContextsRequest.Builder newBuilder(AskContextsRequest prototype)

    • toBuilder

      public AskContextsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AskContextsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AskContextsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AskContextsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<AskContextsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public AskContextsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder