Package ai.vespa.client.dsl

Class FixedQuery

java.lang.Object

ai.vespa.client.dsl.FixedQuery

public class FixedQuery
extends Object

FixedQuery contains a 'Query' which is terminated by a 'semicolon' This object holds vespa or user defined parameters https://docs.vespa.ai/en/reference/query-api-reference.html

Method Summary

Modifier and Type	Method	Description
FixedQuery	bolding(boolean enable)
String	build()	build the vespa query string join by '&'
Map<String,String>	buildQueryMap()	build the query map from the query
FixedQuery	collapseField(String summaryFieldName)
FixedQuery	collapseSize(int size)
FixedQuery	collapseSummary(String summaryClass)
FixedQuery	defaultIndex(String indexName)
FixedQuery	encoding(String encoding)
FixedQuery	filter(String filter)
FixedQuery	format(String format)
FixedQuery	groupingSessionCache(boolean enable)
boolean	hasNegativeSearchField(String fieldName)
boolean	hasNegativeSearchField(String fieldName, Object value)
boolean	hasPositiveSearchField(String fieldName)
boolean	hasPositiveSearchField(String fieldName, Object value)
FixedQuery	hitCountEstimate(boolean enable)
FixedQuery	hits(int hits)
FixedQuery	language(String language)
FixedQuery	locale(String locale)
FixedQuery	location(String location)
FixedQuery	metricsIgnore(boolean bool)
FixedQuery	offset(int offset)
FixedQuery	param(String key, String value)
FixedQuery	params(Map<String,String> params)
FixedQuery	path(String searchPath)
FixedQuery	posBoundingBox(double n, double s, double e, double w)
FixedQuery	posLatLong(double lat, double lon)
FixedQuery	posLatLong(String vespaLatLong)
FixedQuery	posRadiusInKilometer(int km)
FixedQuery	posRadiusInMeter(int m)
FixedQuery	posRadiusInMile(int mi)
FixedQuery	presentationTemplate(String template)
FixedQuery	presentationTiming(boolean enable)
FixedQuery	query(String query)	Deprecated.
FixedQuery	queryProfile(String queryProfile)
FixedQuery	rankfeature(String featureName, String featureValue)
FixedQuery	rankfeatures(boolean enable)
FixedQuery	ranking(String rankProfileName)
FixedQuery	rankingFreshness(String freshness)
FixedQuery	rankingQueryCache(boolean enable)
FixedQuery	rankingSoftTimeout(boolean enable)
FixedQuery	rankingSoftTimeout(boolean enable, double factor)
FixedQuery	rankproperty(String propertyName, String propertyValue)
FixedQuery	recall(String recall)
FixedQuery	restrict(String commaDelimitedDocTypeNames)
FixedQuery	rulesOff(boolean bool)
FixedQuery	rulesRulebase(String rulebase)
FixedQuery	searchChain(String searchChain)
FixedQuery	select(Group group)
FixedQuery	select(String groupSyntax)
FixedQuery	sorting(String sorting)
FixedQuery	sources(String commaDelimitedSourceNames)
FixedQuery	streamingGroupName(String groupName)
FixedQuery	streamingMaxBucketsPerVisitor(int max)
FixedQuery	streamingPriority(String priority)
FixedQuery	streamingSelection(String selection)
FixedQuery	streamingUserId(BigDecimal id)
FixedQuery	summary(String summaryClass)
FixedQuery	timeout(int second)
FixedQuery	timeoutInMs(int milli)
FixedQuery	tracelevel(int level)
FixedQuery	traceTimestamps(boolean enable)
FixedQuery	type(String type)
FixedQuery	user(String user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hits

public FixedQuery hits(int hits)

offset

public FixedQuery offset(int offset)

queryProfile

public FixedQuery queryProfile(String queryProfile)

groupingSessionCache

public FixedQuery groupingSessionCache(boolean enable)

searchChain

public FixedQuery searchChain(String searchChain)

timeout

public FixedQuery timeout(int second)

timeoutInMs

public FixedQuery timeoutInMs(int milli)

tracelevel

public FixedQuery tracelevel(int level)

traceTimestamps

public FixedQuery traceTimestamps(boolean enable)

defaultIndex

public FixedQuery defaultIndex(String indexName)

encoding

public FixedQuery encoding(String encoding)

filter

public FixedQuery filter(String filter)

locale

public FixedQuery locale(String locale)

language

public FixedQuery language(String language)

query

@Deprecated
public FixedQuery query(String query)

Deprecated.

restrict

public FixedQuery restrict(String commaDelimitedDocTypeNames)

path

public FixedQuery path(String searchPath)

sources

public FixedQuery sources(String commaDelimitedSourceNames)

type

public FixedQuery type(String type)

location

public FixedQuery location(String location)

rankfeature

public FixedQuery rankfeature(String featureName,
                              String featureValue)

rankfeatures

public FixedQuery rankfeatures(boolean enable)

ranking

public FixedQuery ranking(String rankProfileName)

rankproperty

public FixedQuery rankproperty(String propertyName,
                               String propertyValue)

rankingSoftTimeout

public FixedQuery rankingSoftTimeout(boolean enable)

rankingSoftTimeout

public FixedQuery rankingSoftTimeout(boolean enable,
                                     double factor)

sorting

public FixedQuery sorting(String sorting)

rankingFreshness

public FixedQuery rankingFreshness(String freshness)

rankingQueryCache

public FixedQuery rankingQueryCache(boolean enable)

bolding

public FixedQuery bolding(boolean enable)

format

public FixedQuery format(String format)

summary

public FixedQuery summary(String summaryClass)

presentationTemplate

public FixedQuery presentationTemplate(String template)

presentationTiming

public FixedQuery presentationTiming(boolean enable)

select

public FixedQuery select(String groupSyntax)

select

public FixedQuery select(Group group)

collapseField

public FixedQuery collapseField(String summaryFieldName)

collapseSummary

public FixedQuery collapseSummary(String summaryClass)

collapseSize

public FixedQuery collapseSize(int size)

posLatLong

public FixedQuery posLatLong(String vespaLatLong)

posLatLong

public FixedQuery posLatLong(double lat,
                             double lon)

posRadiusInKilometer

public FixedQuery posRadiusInKilometer(int km)

posRadiusInMeter

public FixedQuery posRadiusInMeter(int m)

posRadiusInMile

public FixedQuery posRadiusInMile(int mi)

posBoundingBox

public FixedQuery posBoundingBox(double n,
                                 double s,
                                 double e,
                                 double w)

streamingUserId

public FixedQuery streamingUserId(BigDecimal id)

streamingGroupName

public FixedQuery streamingGroupName(String groupName)

streamingSelection

public FixedQuery streamingSelection(String selection)

streamingPriority

public FixedQuery streamingPriority(String priority)

streamingMaxBucketsPerVisitor

public FixedQuery streamingMaxBucketsPerVisitor(int max)

rulesOff

public FixedQuery rulesOff(boolean bool)

rulesRulebase

public FixedQuery rulesRulebase(String rulebase)

recall

public FixedQuery recall(String recall)

user

public FixedQuery user(String user)

hitCountEstimate

public FixedQuery hitCountEstimate(boolean enable)

metricsIgnore

public FixedQuery metricsIgnore(boolean bool)

param

public FixedQuery param(String key,
                        String value)

params

public FixedQuery params(Map<String,String> params)

buildQueryMap

public Map<String,String> buildQueryMap()

build the query map from the query

Returns:

the query map

build

public String build()

build the vespa query string join by '&'

Returns:

the query string

hasPositiveSearchField

public boolean hasPositiveSearchField(String fieldName)

hasPositiveSearchField

public boolean hasPositiveSearchField(String fieldName,
                                      Object value)

hasNegativeSearchField

public boolean hasNegativeSearchField(String fieldName)

hasNegativeSearchField

public boolean hasNegativeSearchField(String fieldName,
                                      Object value)