Interface PostPartitionSearchAsStreamParams

Opaque bookmark token used when paginating results.

Path parameter to specify the database name.

Path parameter to specify the design document name. The design document name is the design document ID excluding the _design/ prefix.

Specifies which fields to highlight. If specified, the result object contains a highlights field with an entry for each specified field.

Number of fragments that are returned in highlights. If the search term occurs less often than the number of fragments that are specified, longer fragments are returned.

A string that is inserted after the highlighted word in the highlights output.

A string that is inserted before the highlighted word in the highlights output.

Number of characters in each fragment for highlights.

Include the full content of the documents in the return.

A JSON array of field names to include in search results. Any fields that are included must be indexed with the store:true option. The default is all fields.

Path parameter to specify the index name.

Limit the number of the returned documents to the specified number.

Path parameter to specify the database partition key.

The Lucene query to execute.

Specifies the sort order of the results. In a grouped search (when group_field is used), this parameter specifies the sort order within a group. The default sort order is relevance. A JSON string of the form "fieldname<type>" or "-fieldname<type>" for descending order, where fieldname is the name of a string or number field, and type is either a number, a string, or a JSON array of strings. The type part is optional, and defaults to number. Some examples are "foo", "-foo", "bar<string>", "-foo<number>" and ["-foo<number>", "bar<string>"]. String fields that are used for sorting must not be analyzed fields. Fields that are used for sorting must be indexed by the same indexer that is used for the search query.

Do not wait for the index to finish building to return results.