Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryLogParams

Parameters for the queryLog operation.

Hierarchy

  • QueryLogParams

Index

Properties

Optional count

count: number

Number of results to return. The maximum for the count and offset values together in any one query is 10000.

Optional filter

filter: string

A cacheable query that excludes documents that don't mention the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set.

Optional headers

headers: OutgoingHttpHeaders

Optional offset

offset: number

The number of query results to skip at the beginning. For example, if the total number of results that are returned is 10 and the offset is 8, it returns the last two results. The maximum for the count and offset values together in any one query is 10000.

Optional query

query: string

A query search returns all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.

Optional sort

sort: string[]

A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by prefixing the field with - for descending or + for ascending. Ascending is the default sort direction if no prefix is specified.

Generated using TypeDoc