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 Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description StringgetAfter()string after = 33;com.google.protobuf.ByteStringgetAfterBytes()string after = 33;intgetAutocut()uint32 autocut = 32;WeaviateProtoSearchGet.BM25getBm25Search()optional .weaviate.v1.BM25 bm25_search = 42;WeaviateProtoSearchGet.BM25OrBuildergetBm25SearchOrBuilder()optional .weaviate.v1.BM25 bm25_search = 42;StringgetCollection()requiredcom.google.protobuf.ByteStringgetCollectionBytes()requiredWeaviateProtoBase.ConsistencyLevelgetConsistencyLevel()optional .weaviate.v1.ConsistencyLevel consistency_level = 11;intgetConsistencyLevelValue()optional .weaviate.v1.ConsistencyLevel consistency_level = 11;WeaviateProtoBase.FiltersgetFilters()matches/searches for objectsWeaviateProtoBase.FiltersOrBuildergetFiltersOrBuilder()matches/searches for objectsWeaviateProtoSearchGet.GenerativeSearchgetGenerative()optional .weaviate.v1.GenerativeSearch generative = 60;WeaviateProtoSearchGet.GenerativeSearchOrBuildergetGenerativeOrBuilder()optional .weaviate.v1.GenerativeSearch generative = 60;WeaviateProtoSearchGet.GroupBygetGroupBy()optional .weaviate.v1.GroupBy group_by = 22;WeaviateProtoSearchGet.GroupByOrBuildergetGroupByOrBuilder()optional .weaviate.v1.GroupBy group_by = 22;WeaviateProtoSearchGet.HybridgetHybridSearch()optional .weaviate.v1.Hybrid hybrid_search = 41;WeaviateProtoSearchGet.HybridOrBuildergetHybridSearchOrBuilder()optional .weaviate.v1.Hybrid hybrid_search = 41;intgetLimit()affects order and length of results.WeaviateProtoSearchGet.MetadataRequestgetMetadata()optional .weaviate.v1.MetadataRequest metadata = 21;WeaviateProtoSearchGet.MetadataRequestOrBuildergetMetadataOrBuilder()optional .weaviate.v1.MetadataRequest metadata = 21;WeaviateProtoSearchGet.NearAudioSearchgetNearAudio()optional .weaviate.v1.NearAudioSearch near_audio = 47;WeaviateProtoSearchGet.NearAudioSearchOrBuildergetNearAudioOrBuilder()optional .weaviate.v1.NearAudioSearch near_audio = 47;WeaviateProtoSearchGet.NearDepthSearchgetNearDepth()optional .weaviate.v1.NearDepthSearch near_depth = 49;WeaviateProtoSearchGet.NearDepthSearchOrBuildergetNearDepthOrBuilder()optional .weaviate.v1.NearDepthSearch near_depth = 49;WeaviateProtoSearchGet.NearImageSearchgetNearImage()optional .weaviate.v1.NearImageSearch near_image = 46;WeaviateProtoSearchGet.NearImageSearchOrBuildergetNearImageOrBuilder()optional .weaviate.v1.NearImageSearch near_image = 46;WeaviateProtoSearchGet.NearIMUSearchgetNearImu()optional .weaviate.v1.NearIMUSearch near_imu = 51;WeaviateProtoSearchGet.NearIMUSearchOrBuildergetNearImuOrBuilder()optional .weaviate.v1.NearIMUSearch near_imu = 51;WeaviateProtoSearchGet.NearObjectgetNearObject()optional .weaviate.v1.NearObject near_object = 44;WeaviateProtoSearchGet.NearObjectOrBuildergetNearObjectOrBuilder()optional .weaviate.v1.NearObject near_object = 44;WeaviateProtoSearchGet.NearTextSearchgetNearText()optional .weaviate.v1.NearTextSearch near_text = 45;WeaviateProtoSearchGet.NearTextSearchOrBuildergetNearTextOrBuilder()optional .weaviate.v1.NearTextSearch near_text = 45;WeaviateProtoSearchGet.NearThermalSearchgetNearThermal()optional .weaviate.v1.NearThermalSearch near_thermal = 50;WeaviateProtoSearchGet.NearThermalSearchOrBuildergetNearThermalOrBuilder()optional .weaviate.v1.NearThermalSearch near_thermal = 50;WeaviateProtoSearchGet.NearVectorgetNearVector()optional .weaviate.v1.NearVector near_vector = 43;WeaviateProtoSearchGet.NearVectorOrBuildergetNearVectorOrBuilder()optional .weaviate.v1.NearVector near_vector = 43;WeaviateProtoSearchGet.NearVideoSearchgetNearVideo()optional .weaviate.v1.NearVideoSearch near_video = 48;WeaviateProtoSearchGet.NearVideoSearchOrBuildergetNearVideoOrBuilder()optional .weaviate.v1.NearVideoSearch near_video = 48;intgetOffset()uint32 offset = 31;WeaviateProtoSearchGet.PropertiesRequestgetProperties()what is returnedWeaviateProtoSearchGet.PropertiesRequestOrBuildergetPropertiesOrBuilder()what is returnedWeaviateProtoSearchGet.RerankgetRerank()optional .weaviate.v1.Rerank rerank = 61;WeaviateProtoSearchGet.RerankOrBuildergetRerankOrBuilder()optional .weaviate.v1.Rerank rerank = 61;WeaviateProtoSearchGet.SortBygetSortBy(int index)protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZEDintgetSortByCount()protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZEDList<WeaviateProtoSearchGet.SortBy>getSortByList()protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZEDWeaviateProtoSearchGet.SortByOrBuildergetSortByOrBuilder(int index)protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZEDList<? extends WeaviateProtoSearchGet.SortByOrBuilder>getSortByOrBuilderList()protolint:disable:next REPEATED_FIELD_NAMES_PLURALIZEDStringgetTenant()parameterscom.google.protobuf.ByteStringgetTenantBytes()parametersbooleangetUses123Api()Deprecated.weaviate.v1.SearchRequest.uses_123_api is deprecated.booleangetUses125Api()bool uses_125_api = 101;booleanhasBm25Search()optional .weaviate.v1.BM25 bm25_search = 42;booleanhasConsistencyLevel()optional .weaviate.v1.ConsistencyLevel consistency_level = 11;booleanhasFilters()matches/searches for objectsbooleanhasGenerative()optional .weaviate.v1.GenerativeSearch generative = 60;booleanhasGroupBy()optional .weaviate.v1.GroupBy group_by = 22;booleanhasHybridSearch()optional .weaviate.v1.Hybrid hybrid_search = 41;booleanhasMetadata()optional .weaviate.v1.MetadataRequest metadata = 21;booleanhasNearAudio()optional .weaviate.v1.NearAudioSearch near_audio = 47;booleanhasNearDepth()optional .weaviate.v1.NearDepthSearch near_depth = 49;booleanhasNearImage()optional .weaviate.v1.NearImageSearch near_image = 46;booleanhasNearImu()optional .weaviate.v1.NearIMUSearch near_imu = 51;booleanhasNearObject()optional .weaviate.v1.NearObject near_object = 44;booleanhasNearText()optional .weaviate.v1.NearTextSearch near_text = 45;booleanhasNearThermal()optional .weaviate.v1.NearThermalSearch near_thermal = 50;booleanhasNearVector()optional .weaviate.v1.NearVector near_vector = 43;booleanhasNearVideo()optional .weaviate.v1.NearVideoSearch near_video = 48;booleanhasProperties()what is returnedbooleanhasRerank()optional .weaviate.v1.Rerank rerank = 61;-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
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
WeaviateProtoSearchGet.Hybrid getHybridSearch()
optional .weaviate.v1.Hybrid hybrid_search = 41;- Returns:
- The hybridSearch.
-
getHybridSearchOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.BM25 getBm25Search()
optional .weaviate.v1.BM25 bm25_search = 42;- Returns:
- The bm25Search.
-
getBm25SearchOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearVector getNearVector()
optional .weaviate.v1.NearVector near_vector = 43;- Returns:
- The nearVector.
-
getNearVectorOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearObject getNearObject()
optional .weaviate.v1.NearObject near_object = 44;- Returns:
- The nearObject.
-
getNearObjectOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearTextSearch getNearText()
optional .weaviate.v1.NearTextSearch near_text = 45;- Returns:
- The nearText.
-
getNearTextOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearImageSearch getNearImage()
optional .weaviate.v1.NearImageSearch near_image = 46;- Returns:
- The nearImage.
-
getNearImageOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearAudioSearch getNearAudio()
optional .weaviate.v1.NearAudioSearch near_audio = 47;- Returns:
- The nearAudio.
-
getNearAudioOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearVideoSearch getNearVideo()
optional .weaviate.v1.NearVideoSearch near_video = 48;- Returns:
- The nearVideo.
-
getNearVideoOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearDepthSearch getNearDepth()
optional .weaviate.v1.NearDepthSearch near_depth = 49;- Returns:
- The nearDepth.
-
getNearDepthOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearThermalSearch getNearThermal()
optional .weaviate.v1.NearThermalSearch near_thermal = 50;- Returns:
- The nearThermal.
-
getNearThermalOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.NearIMUSearch getNearImu()
optional .weaviate.v1.NearIMUSearch near_imu = 51;- Returns:
- The nearImu.
-
getNearImuOrBuilder
WeaviateProtoSearchGet.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
WeaviateProtoSearchGet.GenerativeSearch getGenerative()
optional .weaviate.v1.GenerativeSearch generative = 60;- Returns:
- The generative.
-
getGenerativeOrBuilder
WeaviateProtoSearchGet.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=50bool uses_123_api = 100 [deprecated = true];- Returns:
- The uses123Api.
-
getUses125Api
boolean getUses125Api()
bool uses_125_api = 101;- Returns:
- The uses125Api.
-
-