package protocol.sdk.search

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Result

• repeated SearchRow rows = 1

• optional SearchFacets facets = 2

• optional SearchMetaData meta_data = 3

Used in: SearchQuery

• bool bool = 1

• optional string field = 2

• optional float boost = 3

Used in: SearchQuery

• repeated SearchQuery must = 1

  Note these are all guaranteed to be ConjunctionQuerys. SearchQuery is sent instead as it makes it much easier to write recursive handling code in the performer.

• repeated SearchQuery should = 2

  All guaranteed to be DisjunctionQuerys.

• optional uint32 should_min = 3

• repeated SearchQuery must_not = 4

  All guaranteed to be DisjunctionQuerys.

• optional float boost = 5

Used in: SearchQuery

• repeated SearchQuery conjuncts = 1

• optional float boost = 2

Used in: DateRangeFacet

• string name = 1

• optional google.protobuf.Timestamp start = 2

• optional google.protobuf.Timestamp end = 3

Used in: SearchFacet

• string field = 1

• optional uint32 size = 2

• repeated DateRange date_ranges = 3

Used in: SearchQuery

• optional string start = 1

• optional bool inclusive_start = 2

• optional string end = 3

• optional bool inclusive_end = 4

• optional string datetime_parser = 5

• optional string field = 6

• optional float boost = 7

Used in: SearchQuery

• repeated SearchQuery disjuncts = 1

• optional uint32 min = 2

• optional float boost = 3

Used in: SearchQuery

• repeated string ids = 1

• optional float boost = 2

Used in: SearchQuery

• optional Location top_left = 1

• optional Location bottom_right = 2

• optional string field = 3

• optional float boost = 4

Used in: SearchQuery

• optional Location location = 1

• string distance = 2

• optional string field = 3

• optional float boost = 4

Used in: SearchOptions

• optional HighlightStyle style = 1

• repeated string fields = 2

  There is no `optional repeated`, so if this field is empty, regard it as not provided. E.g. we cannot test providing sending an empty list of fields into the SDK.

Used in: Highlight

• HIGHLIGHT_STYLE_HTML = 0

• HIGHLIGHT_STYLE_ANSI = 2

Used in: GeoBoundingBoxQuery, GeoDistanceQuery, SearchSortGeoDistance

• float lon = 3

• float lat = 4

Used in: SearchQuery

(message has no fields)

Used in: SearchQuery

(message has no fields)

Used in: MatchQuery

• SEARCH_MATCH_OPERATOR_OR = 0

• SEARCH_MATCH_OPERATOR_AND = 1

Used in: SearchQuery

• string match_phrase = 1

• optional string field = 2

• optional string analyzer = 3

• optional float boost = 4

Used in: SearchQuery

• string match = 1

• optional string field = 2

• optional string analyzer = 3

• optional uint32 prefix_length = 4

• optional uint32 fuzziness = 5

• optional float boost = 6

• optional MatchOperator operator = 7

Used in: NumericRangeFacet

• string name = 1

• optional float min = 2

• optional float max = 3

Used in: SearchFacet

• string field = 1

• optional uint32 size = 2

• repeated NumericRange numeric_ranges = 3

Used in: SearchQuery

• optional float min = 1

• optional bool inclusive_min = 2

• optional float max = 3

• optional bool inclusive_max = 4

• optional string field = 5

• optional float boost = 6

Used in: SearchQuery

• repeated string terms = 1

• optional string field = 2

• optional float boost = 3

Used in: SearchQuery

• string prefix = 1

• optional string field = 2

• optional float boost = 3

Used in: SearchQuery

• string query = 1

• optional float boost = 2

Used in: SearchQuery

• string regexp = 1

• optional string field = 2

• optional float boost = 3

Executing a `cluster.searchQuery()` FTS query. The performer can return either: 1. An protocol.sdk.Result.exception, if the `cluster/scope.searchQuery()` call immediately fails. 2. A BlockingSearchResult, iff that's the most natural representation. For example, the Java SDK's blocking API would return this. The performer should not select this just because it's easier to implement than the stream! Most SDK APIs have streaming responses and should instead use: 3. A stream. This consists of streaming back: 3.1 A streams.Created, with type STREAM_FULL_TEXT_SEARCH. 3.2 Zero+ StreamingSearchResults, which contain the FTS rows, facets and metadata. 3.3 A streams.Complete. And as usual the performer should handle requests for more items, stream cancellation requests, and look at stream_config for details of how to stream. See streams.top_level.proto for details. If any error occurs on the stream (as opposed to from the initial cluster.search() call) as usual return a streams.Error.

Used in: ClusterLevelCommand, ScopeLevelCommand

• string indexName = 1

• optional SearchQuery query = 2

• optional SearchOptions options = 3

• optional shared.ContentAs fields_as = 4

  Controls how SearchRow.fields should be converted. Only applied if a BlockingSearchResult is being returned. If not present, the performer should not do result.fieldsAs().

• optional streams.Config stream_config = 5

  Not sent on to the SDK - instead specifies how the performer should handle any streaming. Can be ignored if the performer is choosing to return a BlockingSearchResult rather than a stream.

Used in: SearchOptions

• oneof facet

  • TermFacet term = 1

  • NumericRangeFacet numeric_range = 2

  • DateRangeFacet date_range = 3

Used in: SearchFacets

• string name = 1

• string field = 2

• uint64 total = 3

• uint64 missing = 4

• uint64 other = 5

Used in: BlockingSearchResult, StreamingSearchResult

• map<string, SearchFacetResult> facets = 1

Used in: SearchRow

• repeated string fragments = 1

Used in: SearchSortGeoDistance

• SEARCH_GEO_DISTANCE_UNITS_METERS = 0

• SEARCH_GEO_DISTANCE_UNITS_MILES = 1

• SEARCH_GEO_DISTANCE_UNITS_CENTIMETERS = 2

• SEARCH_GEO_DISTANCE_UNITS_MILLIMETERS = 3

• SEARCH_GEO_DISTANCE_UNITS_NAUTICAL_MILES = 4

• SEARCH_GEO_DISTANCE_UNITS_KILOMETERS = 5

• SEARCH_GEO_DISTANCE_UNITS_FEET = 6

• SEARCH_GEO_DISTANCE_UNITS_YARDS = 7

• SEARCH_GEO_DISTANCE_UNITS_INCHES = 8

Used in: BlockingSearchResult, StreamingSearchResult

• optional SearchMetrics metrics = 1

• map<string, string> errors = 2

Used in: SearchMetaData

• int64 took_msec = 1

• int64 total_rows = 2

• double max_score = 3

• int64 total_partition_count = 4

• int64 success_partition_count = 5

• int64 error_partition_count = 6

Used in: Search, SearchV2

• optional uint32 limit = 1

• optional uint32 skip = 2

• optional bool explain = 3

• optional Highlight highlight = 4

• repeated string fields = 5

  There is no `optional repeated`, so if this field is empty, regard it as not provided.

• optional SearchScanConsistency scan_consistency = 6

• optional shared.MutationState consistent_with = 7

• repeated SearchSort sort = 8

  There is no `optional repeated`, so if this field is empty, regard it as not provided.

• map<string, SearchFacet> facets = 9

  There is no `optional map`, so if this field is empty, regard it as not provided.

• optional int64 timeout_millis = 10

• optional string parent_span_id = 11

• map<string, string> raw = 12

• optional bool include_locations = 13

• optional shared.JsonSerializer serialize = 14

Used in: BooleanQuery, ConjunctionQuery, DisjunctionQuery, Search, SearchRequest, VectorQueryOptions

• oneof query

  • MatchQuery match = 1

  • MatchPhraseQuery match_phrase = 2

  • RegexpQuery regexp = 3

  • QueryStringQuery query_string = 4

  • WildcardQuery wildcard = 5

  • DocIdQuery doc_id = 6

  • BooleanFieldQuery search_boolean_field = 7

    Cannot be named boolean_field as it causes issues in generated code for at least Java

  • DateRangeQuery date_range = 8

  • NumericRangeQuery numeric_range = 9

  • TermRangeQuery term_range = 20

  • GeoDistanceQuery geo_distance = 10

  • GeoBoundingBoxQuery geo_bounding_box = 11

  • ConjunctionQuery conjunction = 12

  • DisjunctionQuery disjunction = 13

  • BooleanQuery boolean = 14

  • TermQuery term = 15

  • PrefixQuery prefix = 16

  • PhraseQuery phrase = 17

  • MatchAllQuery match_all = 18

  • MatchNoneQuery match_none = 19

At least one of these will usually be specified. If both are not specified, the SDK should simulate the user not providing either - e.g. providing null or similar for both.

Used in: SearchV2

• optional SearchQuery search_query = 1

• optional VectorSearch vector_search = 2

Used in: BlockingSearchResult, StreamingSearchResult

• string index = 1

• string id = 2

• double score = 3

• bytes explanation = 4

• repeated SearchRowLocation locations = 5

  The result of calling result.locations.getAll(). If result.locations is missing, return nothing here.

• map<string, SearchFragments> fragments = 6

• optional shared.ContentTypes fields = 7

Used in: SearchRow

• string field = 1

• string term = 2

• uint32 position = 3

• uint32 start = 4

• uint32 end = 5

• repeated uint32 array_positions = 6

Used in: SearchOptions

• SEARCH_SCAN_CONSISTENCY_NOT_BOUNDED = 0

Used in: SearchOptions

• oneof sort

  • SearchSortScore score = 1

  • SearchSortId id = 2

  • SearchSortField field = 3

  • SearchSortGeoDistance geo_distance = 4

  • string raw = 5

Used in: SearchSort

• optional bool desc = 1

• string field = 2

• optional string type = 3

  possible values are "auto", "string", "number", "date"

• optional string mode = 4

  possible values are "default", "min", "max"

• optional string missing = 5

  possible values are "first", "last"

Used in: SearchSort

• optional bool desc = 1

• string field = 2

• optional Location location = 3

• optional SearchGeoDistanceUnits unit = 4

Used in: SearchSort

• optional bool desc = 1

Used in: SearchSort

• optional bool desc = 1

Note that "V2" naming should not be used anywhere in the SDK itself for this feature. It's purely to workaround having an existing "Search" wrapper message in the GRPC.

Used in: SearchWrapper

• string indexName = 1

• optional SearchRequest request = 2

• optional SearchOptions options = 3

Executing either a `cluster.search()` or `scope.search()` FTS query. This is the new API, replacing `cluster.searchQuery()`, that also supports vector search. The performer can return one of these 3: 1. An protocol.sdk.Result.exception, if the `cluster/scope.search()` call immediately fails. 2. A BlockingSearchResult, but only if that's genuinely the most natural representation. For example, the Java SDK's blocking API would return this. The performer should not select this just because it's easier to implement than the stream! Supporting streams allows more sophisticated FIT tests to be performed. Most SDK APIs have streaming responses and should instead use: 3. A stream. This consists of streaming back: 3.1 A streams.Created, with type STREAM_FULL_TEXT_SEARCH. 3.2 Zero+ StreamingSearchResults, which contain the FTS rows, facets and metadata. 3.3 A streams.Complete. And as usual the performer should handle requests for more items, stream cancellation requests, and look at stream_config for details of how to stream. See streams.top_level.proto for details. If any error occurs on the stream (as opposed to from the initial cluster/scope.search() call) as usual return a streams.Error. Note the same types are used as for `cluster/scope.searchQuery()`, reflecting the API.

Used in: ClusterLevelCommand, ScopeLevelCommand

• optional SearchV2 search = 1

  Represents the SDK search.

• optional shared.ContentAs fields_as = 2

  Specifies how the performer should convert SearchRow.fields. If not present, the performer should not do result.fieldsAs().

• optional streams.Config stream_config = 3

  Specifies how the performer should handle any streaming. Can be ignored if the performer is returning a BlockingSearchResult rather than a stream.

Used in: Result

• string stream_id = 1

  Not part of the SDK response - identifies what stream this is from.

• oneof result

  • SearchRow row = 2

    Driver expects to see 0+ of these of stream.

  • SearchFacets facets = 3

    Driver expects to see 0 or 1 of these, after all rows.

  • SearchMetaData meta_data = 4

    Driver expects to see exactly 1 of these, after all rows and facets. (Unless the stream errors.)

Used in: SearchFacet

• string field = 1

• optional uint32 size = 2

Used in: SearchQuery

• string term = 1

• optional string field = 2

• optional uint32 fuzziness = 3

• optional uint32 prefix_length = 4

• optional float boost = 5

Used in: SearchQuery

• optional string min = 1

• optional bool inclusive_min = 2

• optional string max = 3

• optional bool inclusive_max = 4

• optional string field = 5

• optional float boost = 6

Used in: VectorSearch

• repeated float vector_query = 1

• string vector_field_name = 2

• optional VectorQueryOptions options = 3

• optional string base64_vector_query = 4

Used in: VectorSearchOptions

• AND = 0

• OR = 1

Used in: VectorQuery

• optional int32 num_candidates = 1

• optional float boost = 2

• optional SearchQuery prefilter = 3

Used in: SearchRequest

• repeated VectorQuery vector_query = 1

• optional VectorSearchOptions options = 2

Used in: VectorSearch

• optional VectorQueryCombination vector_query_combination = 1

Used in: SearchQuery

• string wildcard = 1

• optional string field = 2

• optional float boost = 3