Package io.weaviate.client.grpc.protocol.v1

Interface WeaviateProtoSearchGet.SearchRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WeaviateProtoSearchGet.SearchRequest, WeaviateProtoSearchGet.SearchRequest.Builder
Enclosing class:
WeaviateProtoSearchGet
public static interface WeaviateProtoSearchGet.SearchRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCollection

      String getCollection()
      required
      string collection = 1;
      Returns:
      The collection.

    • getCollectionBytes

      com.google.protobuf.ByteString getCollectionBytes()
      required
      string collection = 1;
      Returns:
      The bytes for collection.

    • getTenant

      String getTenant()
       parameters
      string tenant = 10;
      Returns:
      The tenant.

    • getTenantBytes

      com.google.protobuf.ByteString getTenantBytes()
       parameters
      string tenant = 10;
      Returns:
      The bytes for tenant.

    • hasConsistencyLevel

      boolean hasConsistencyLevel()
      optional .weaviate.v1.ConsistencyLevel consistency_level = 11;
      Returns:
      Whether the consistencyLevel field is set.

    • getConsistencyLevelValue

      int getConsistencyLevelValue()
      optional .weaviate.v1.ConsistencyLevel consistency_level = 11;
      Returns:
      The enum numeric value on the wire for consistencyLevel.

    • getConsistencyLevel

      WeaviateProtoBase.ConsistencyLevel getConsistencyLevel()
      optional .weaviate.v1.ConsistencyLevel consistency_level = 11;
      Returns:
      The consistencyLevel.

    • hasProperties

      boolean hasProperties()
       what is returned
      optional .weaviate.v1.PropertiesRequest properties = 20;
      Returns:
      Whether the properties field is set.

    • getProperties

      WeaviateProtoSearchGet.PropertiesRequest getProperties()
       what is returned
      optional .weaviate.v1.PropertiesRequest properties = 20;
      Returns:
      The properties.

    • getPropertiesOrBuilder

      WeaviateProtoSearchGet.PropertiesRequestOrBuilder getPropertiesOrBuilder()
       what is returned
      optional .weaviate.v1.PropertiesRequest properties = 20;

    • hasMetadata

      boolean hasMetadata()
      optional .weaviate.v1.MetadataRequest metadata = 21;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      WeaviateProtoSearchGet.MetadataRequest getMetadata()
      optional .weaviate.v1.MetadataRequest metadata = 21;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      WeaviateProtoSearchGet.MetadataRequestOrBuilder getMetadataOrBuilder()
      optional .weaviate.v1.MetadataRequest metadata = 21;

    • hasGroupBy

      boolean hasGroupBy()
      optional .weaviate.v1.GroupBy group_by = 22;
      Returns:
      Whether the groupBy field is set.

    • getGroupBy

      WeaviateProtoSearchGet.GroupBy getGroupBy()
      optional .weaviate.v1.GroupBy group_by = 22;
      Returns:
      The groupBy.

    • getGroupByOrBuilder

      WeaviateProtoSearchGet.GroupByOrBuilder getGroupByOrBuilder()
      optional .weaviate.v1.GroupBy group_by = 22;

    • getLimit

      int getLimit()
       affects order and length of results. 0/empty (default value) means disabled
      uint32 limit = 30;
      Returns:
      The limit.

    • getOffset

      int getOffset()
      uint32 offset = 31;
      Returns:
      The offset.

    • getAutocut

      int getAutocut()
      uint32 autocut = 32;
      Returns:
      The autocut.

    • getAfter

      String getAfter()
      string after = 33;
      Returns:
      The after.

    • getAfterBytes

      com.google.protobuf.ByteString getAfterBytes()
      string after = 33;
      Returns:
      The bytes for after.

    • getSortByList

      List<WeaviateProtoSearchGet.SortBy> getSortByList()
       protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
      repeated .weaviate.v1.SortBy sort_by = 34;

    • getSortBy

      WeaviateProtoSearchGet.SortBy getSortBy(int index)
       protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
      repeated .weaviate.v1.SortBy sort_by = 34;

    • getSortByCount

      int getSortByCount()
       protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
      repeated .weaviate.v1.SortBy sort_by = 34;

    • getSortByOrBuilderList

      List<? extends WeaviateProtoSearchGet.SortByOrBuilder> getSortByOrBuilderList()
       protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
      repeated .weaviate.v1.SortBy sort_by = 34;

    • getSortByOrBuilder

      WeaviateProtoSearchGet.SortByOrBuilder getSortByOrBuilder(int index)
       protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZED
      repeated .weaviate.v1.SortBy sort_by = 34;

    • hasFilters

      boolean hasFilters()
       matches/searches for objects
      optional .weaviate.v1.Filters filters = 40;
      Returns:
      Whether the filters field is set.

    • getFilters

      WeaviateProtoBase.Filters getFilters()
       matches/searches for objects
      optional .weaviate.v1.Filters filters = 40;
      Returns:
      The filters.

    • getFiltersOrBuilder

      WeaviateProtoBase.FiltersOrBuilder getFiltersOrBuilder()
       matches/searches for objects
      optional .weaviate.v1.Filters filters = 40;

    • hasHybridSearch

      boolean hasHybridSearch()
      optional .weaviate.v1.Hybrid hybrid_search = 41;
      Returns:
      Whether the hybridSearch field is set.

    • getHybridSearch

      WeaviateProtoBaseSearch.Hybrid getHybridSearch()
      optional .weaviate.v1.Hybrid hybrid_search = 41;
      Returns:
      The hybridSearch.

    • getHybridSearchOrBuilder

      WeaviateProtoBaseSearch.HybridOrBuilder getHybridSearchOrBuilder()
      optional .weaviate.v1.Hybrid hybrid_search = 41;

    • hasBm25Search

      boolean hasBm25Search()
      optional .weaviate.v1.BM25 bm25_search = 42;
      Returns:
      Whether the bm25Search field is set.

    • getBm25Search

      WeaviateProtoBaseSearch.BM25 getBm25Search()
      optional .weaviate.v1.BM25 bm25_search = 42;
      Returns:
      The bm25Search.

    • getBm25SearchOrBuilder

      WeaviateProtoBaseSearch.BM25OrBuilder getBm25SearchOrBuilder()
      optional .weaviate.v1.BM25 bm25_search = 42;

    • hasNearVector

      boolean hasNearVector()
      optional .weaviate.v1.NearVector near_vector = 43;
      Returns:
      Whether the nearVector field is set.

    • getNearVector

      WeaviateProtoBaseSearch.NearVector getNearVector()
      optional .weaviate.v1.NearVector near_vector = 43;
      Returns:
      The nearVector.

    • getNearVectorOrBuilder

      WeaviateProtoBaseSearch.NearVectorOrBuilder getNearVectorOrBuilder()
      optional .weaviate.v1.NearVector near_vector = 43;

    • hasNearObject

      boolean hasNearObject()
      optional .weaviate.v1.NearObject near_object = 44;
      Returns:
      Whether the nearObject field is set.

    • getNearObject

      WeaviateProtoBaseSearch.NearObject getNearObject()
      optional .weaviate.v1.NearObject near_object = 44;
      Returns:
      The nearObject.

    • getNearObjectOrBuilder

      WeaviateProtoBaseSearch.NearObjectOrBuilder getNearObjectOrBuilder()
      optional .weaviate.v1.NearObject near_object = 44;

    • hasNearText

      boolean hasNearText()
      optional .weaviate.v1.NearTextSearch near_text = 45;
      Returns:
      Whether the nearText field is set.

    • getNearText

      WeaviateProtoBaseSearch.NearTextSearch getNearText()
      optional .weaviate.v1.NearTextSearch near_text = 45;
      Returns:
      The nearText.

    • getNearTextOrBuilder

      WeaviateProtoBaseSearch.NearTextSearchOrBuilder getNearTextOrBuilder()
      optional .weaviate.v1.NearTextSearch near_text = 45;

    • hasNearImage

      boolean hasNearImage()
      optional .weaviate.v1.NearImageSearch near_image = 46;
      Returns:
      Whether the nearImage field is set.

    • getNearImage

      WeaviateProtoBaseSearch.NearImageSearch getNearImage()
      optional .weaviate.v1.NearImageSearch near_image = 46;
      Returns:
      The nearImage.

    • getNearImageOrBuilder

      WeaviateProtoBaseSearch.NearImageSearchOrBuilder getNearImageOrBuilder()
      optional .weaviate.v1.NearImageSearch near_image = 46;

    • hasNearAudio

      boolean hasNearAudio()
      optional .weaviate.v1.NearAudioSearch near_audio = 47;
      Returns:
      Whether the nearAudio field is set.

    • getNearAudio

      WeaviateProtoBaseSearch.NearAudioSearch getNearAudio()
      optional .weaviate.v1.NearAudioSearch near_audio = 47;
      Returns:
      The nearAudio.

    • getNearAudioOrBuilder

      WeaviateProtoBaseSearch.NearAudioSearchOrBuilder getNearAudioOrBuilder()
      optional .weaviate.v1.NearAudioSearch near_audio = 47;

    • hasNearVideo

      boolean hasNearVideo()
      optional .weaviate.v1.NearVideoSearch near_video = 48;
      Returns:
      Whether the nearVideo field is set.

    • getNearVideo

      WeaviateProtoBaseSearch.NearVideoSearch getNearVideo()
      optional .weaviate.v1.NearVideoSearch near_video = 48;
      Returns:
      The nearVideo.

    • getNearVideoOrBuilder

      WeaviateProtoBaseSearch.NearVideoSearchOrBuilder getNearVideoOrBuilder()
      optional .weaviate.v1.NearVideoSearch near_video = 48;

    • hasNearDepth

      boolean hasNearDepth()
      optional .weaviate.v1.NearDepthSearch near_depth = 49;
      Returns:
      Whether the nearDepth field is set.

    • getNearDepth

      WeaviateProtoBaseSearch.NearDepthSearch getNearDepth()
      optional .weaviate.v1.NearDepthSearch near_depth = 49;
      Returns:
      The nearDepth.

    • getNearDepthOrBuilder

      WeaviateProtoBaseSearch.NearDepthSearchOrBuilder getNearDepthOrBuilder()
      optional .weaviate.v1.NearDepthSearch near_depth = 49;

    • hasNearThermal

      boolean hasNearThermal()
      optional .weaviate.v1.NearThermalSearch near_thermal = 50;
      Returns:
      Whether the nearThermal field is set.

    • getNearThermal

      WeaviateProtoBaseSearch.NearThermalSearch getNearThermal()
      optional .weaviate.v1.NearThermalSearch near_thermal = 50;
      Returns:
      The nearThermal.

    • getNearThermalOrBuilder

      WeaviateProtoBaseSearch.NearThermalSearchOrBuilder getNearThermalOrBuilder()
      optional .weaviate.v1.NearThermalSearch near_thermal = 50;

    • hasNearImu

      boolean hasNearImu()
      optional .weaviate.v1.NearIMUSearch near_imu = 51;
      Returns:
      Whether the nearImu field is set.

    • getNearImu

      WeaviateProtoBaseSearch.NearIMUSearch getNearImu()
      optional .weaviate.v1.NearIMUSearch near_imu = 51;
      Returns:
      The nearImu.

    • getNearImuOrBuilder

      WeaviateProtoBaseSearch.NearIMUSearchOrBuilder getNearImuOrBuilder()
      optional .weaviate.v1.NearIMUSearch near_imu = 51;

    • hasGenerative

      boolean hasGenerative()
      optional .weaviate.v1.GenerativeSearch generative = 60;
      Returns:
      Whether the generative field is set.

    • getGenerative

      WeaviateProtoGenerative.GenerativeSearch getGenerative()
      optional .weaviate.v1.GenerativeSearch generative = 60;
      Returns:
      The generative.

    • getGenerativeOrBuilder

      WeaviateProtoGenerative.GenerativeSearchOrBuilder getGenerativeOrBuilder()
      optional .weaviate.v1.GenerativeSearch generative = 60;

    • hasRerank

      boolean hasRerank()
      optional .weaviate.v1.Rerank rerank = 61;
      Returns:
      Whether the rerank field is set.

    • getRerank

      WeaviateProtoSearchGet.Rerank getRerank()
      optional .weaviate.v1.Rerank rerank = 61;
      Returns:
      The rerank.

    • getRerankOrBuilder

      WeaviateProtoSearchGet.RerankOrBuilder getRerankOrBuilder()
      optional .weaviate.v1.Rerank rerank = 61;

    • getUses123Api

      @Deprecated boolean getUses123Api()
      Deprecated.
      weaviate.v1.SearchRequest.uses_123_api is deprecated. See v1/search_get.proto;l=52
      bool uses_123_api = 100 [deprecated = true];
      Returns:
      The uses123Api.

    • getUses125Api

      @Deprecated boolean getUses125Api()
      Deprecated.
      weaviate.v1.SearchRequest.uses_125_api is deprecated. See v1/search_get.proto;l=53
      bool uses_125_api = 101 [deprecated = true];
      Returns:
      The uses125Api.

    • getUses127Api

      boolean getUses127Api()
      bool uses_127_api = 102;
      Returns:
      The uses127Api.