Skip to main content
Version: Latest

KeywordHitsFilter

input KeywordHitsFilter {
query: String!
proximity: Int
scope: SearchScope @deprecated
scopes: [HitsSearchScope!]
companyProximityTickers: [String!]
}

Fields

KeywordHitsFilter.query ● String! non-null scalar

Can contain simple keywords as well as logical expressions. Example: "earnings AND (cash OR inventory)"

Adding an extra set of quotes (escaped with backslashes) will provide exact search results (without smart synonyms). Example: ",",cash,,""

KeywordHitsFilter.proximity ● Int scalar

This is the maximum distance between given query terms. It specifies how close together the keywords must appear to be considered a hit.

KeywordHitsFilter.scope ● SearchScope deprecated enum

DEPRECATED: Use scopes instead

Restricts the search to specific scope. The default value is DOCUMENT_CONTENT for external API access, ANYWHERE for internal access.

KeywordHitsFilter.scopes ● [HitsSearchScope!] list enum

Restricts the search to specific scopes. The default value is [DOCUMENT_CONTENT, ANNOTATION]

KeywordHitsFilter.companyProximityTickers ● [String!] list scalar

Find hits near of these tickers. These are internal AlphaSense company ids for example TK908440

Member of

Document__snippets query ● KeywordHitsInput input