Document.snippets

Enterprise

description

Allows getting snippets for the search query. API requests for snippets in Research documents are not supported.

snippets(
  keywordFilter: KeywordHitsFilter
  limit: Int = 5
  offset: Int = 0
): KeywordResult

Arguments

snippets.keywordFilter ● KeywordHitsFilter input graph-ql-types

By default coming from search. The 'scope' field is ignored at the moment.

snippets.limit ● Int scalar graph-ql-types

Limits the number of snippets to return. The maximum limit is 20.

snippets.offset ● Int scalar graph-ql-types

Offset the results for pagination purposes

Type

KeywordResult object graph-ql-types

Loading...