pyvespa API reference

146 public APIs from pyvespa (vespa-engine/pyvespa) — 9 classes, 27 functions, 110 methods. Signatures extracted by static analysis of the actual source.

Repository: vespa-engine/pyvespa

Kind	Count
Classes	9
Functions	27
Methods	110

API list

funcresults.inference.onnxbench.get_hf_commit_sha(repo_id:str, branch:str='main') -> str

Get the commit SHA for a HuggingFace repo.

funcresults.inference.onnxbench.get_hf_repo_from_url(url:str) -> str | None

Extract HuggingFace repo ID from a model URL.

funcresults.inference.onnxbench.set_seed(seed:int)

Set seed for reproducibility.

funcvespa.application.get_profiling_params() -> Dict[str, str]

Get the profiling parameters to add to a query.

funcvespa.application.raise_for_status(response:Response, raise_on_not_found:Optional[bool]=False) -> None

Raises an appropriate error if necessary.

funcvespa.configuration.vt.elements_equal(e1, e2)

Compare two elements for equality.

classvespa.evaluation._base.RandomHitsSamplingStrategy

Enum for different random hits sampling strategies.

classvespa.evaluation._base.VespaEvaluator

Evaluate retrieval performance on a Vespa application.

classvespa.evaluation._base.VespaNNRecallEvaluator

Determine recall of ANN queries.

funcvespa.evaluation._base.VespaNNRecallEvaluator.extract_id(hit:dict, id_field:str) -> Tuple[str, str]

Extract document ID from a Vespa hit.

methodvespa.evaluation._base.VespaNNRecallEvaluator.run() -> List[float]

Computes the recall of the supplied queries.

funcvespa.evaluation._base.calculate_searchtime_stats(searchtimes:List[float]) -> Dict[str, float]

Calculate search time statistics.

func

vespa.evaluation._base.execute_queries(app:Vespa, query_bodies:List[dict], max_concurrent:int=10) -> Tuple[List[VespaQueryResponse], List[float]]

Execute queries and collect timing information.

funcvespa.evaluation._base.extract_doc_id_from_hit(hit:dict, id_field:str) -> str

Extract document ID from a Vespa hit.

funcvespa.evaluation._base.filter_queries(queries:Dict[str, str], relevant_docs:Dict[str, Set[str]]) -> List[str]

Filter out queries that have no relevant docs

funcvespa.evaluation._base.get_id_field_from_hit(hit:dict, id_field:str) -> str

Get the ID field from a Vespa hit.

funcvespa.evaluation._base.log_metrics(name:str, metrics:Dict[str, float]) -> None

Log metrics with appropriate formatting.

funcvespa.evaluation._base.mean(values:List[float]) -> float

Compute the mean of a list of numbers without using numpy.

funcvespa.evaluation._base.percentile(values:List[float], p:float) -> float

Compute the p-th percentile of a list of values (0 <= p <= 100).

func

vespa.evaluation._base.validate_qrels(qrels:Union[Dict[Union[str, int], Union[Set[str], Dict[str, float]]], Dict[Union[str, int], str]]) -> Dict[str, Union[Set[str], Dict[str, float]]]

Validate and normalize qrels.

funcvespa.evaluation._base.validate_queries(queries:Dict[Union[str, int], str]) -> Dict[str, str]

Validate and normalize queries.

funcvespa.evaluation._base.validate_vespa_query_fn(fn:Callable) -> bool

Validates the vespa_query_fn function.

func

vespa.evaluation._base.write_csv(metrics:Dict[str, float], searchtime_stats:Dict[str, float], csv_file:str, csv_dir:Optional[str], name:str) -> None

Write metrics to CSV file.

classvespa.evaluation._mteb.VespaMTEBEvaluator

Evaluator class for running MTEB benchmarks with Vespa.

methodvespa.evaluation._mteb.VespaMTEBEvaluator.cleanup() -> None

Clean up the Vespa app instance if one exists.

methodvespa.evaluation._mteb.VespaMTEBEvaluator.evaluate() -> dict

Run the MTEB evaluation.

classvespa.exceptions.VespaError

Vespa returned an error response

classvespa.io.VespaResponse

Class to represent a Vespa HTTP API response.

methodvespa.io.VespaResponse.get_json() -> Dict

Return json of the response.

methodvespa.io.VespaResponse.get_status_code() -> int

Return status code of the response.

methodvespa.io.VespaResponse.is_successful() -> bool

True if status code is 200.

methodvespa.io.VespaResponse.is_successfull() -> bool

[Deprecated] Use is_successful() instead

classvespa.models.ModelConfig

Configuration for an embedding model.

methodvespa.models.ModelConfig.to_dict(include_none:bool=False) -> Dict[str, Any]

Convert the ModelConfig to a dictionary for serialization.

funcvespa.models.get_model_config(model_name:str) -> ModelConfig

Get a predefined model configuration by name.

funcvespa.models.list_models() -> List[str]

List all available predefined model configurations.

funcvespa.models.sanitize_component_id(model_id:str) -> str

Sanitize a model ID to create a valid Vespa component identifier.

funcvespa.package.Component.create_component(id, cls, bundle, type, parameters)

Create a Vespa Component.

methodvespa.package.Document.add_fields(*fields:Field) -> None

Add `Field` objects to the document.

methodvespa.package.Document.add_structs(*structs:Struct) -> None

Add `Struct` objects to the document.

methodvespa.package.Field.add_struct_fields(*struct_fields:StructField) -> None

Add `StructField`'s to the `Field`.

classvespa.package.FieldConfiguration

alias (list[str]): Add alias to the field.

methodvespa.package.Schema.add_document_summary(document_summary:DocumentSummary) -> None

Add a `DocumentSummary` to the Schema.

methodvespa.package.Schema.add_field_set(field_set:FieldSet) -> None

Add a `FieldSet` to the Schema.

methodvespa.package.Schema.add_fields(*fields:Field) -> None

Add `Field` to the Schema's `Document`.

methodvespa.package.Schema.add_imported_field(imported_field:ImportedField) -> None

Add an `ImportedField` to the Schema.

methodvespa.package.Schema.add_model(model:OnnxModel) -> None

Add an `OnnxModel` to the Schema.

methodvespa.package.Schema.add_rank_profile(rank_profile:RankProfile) -> None

Add a `RankProfile` to the Schema.

methodvespa.querybuilder.builder.builder.Condition.all(*conditions:Condition) -> Condition

Combine multiple conditions using logical AND.

methodvespa.querybuilder.builder.builder.Condition.any(*conditions:Condition) -> Condition

Combine multiple conditions using logical OR.

classvespa.querybuilder.builder.builder.Q

Wrapper class for QueryBuilder static methods.

methodvespa.querybuilder.builder.builder.Q.all(*conditions:Condition) -> Condition

Combines multiple conditions with AND operator.

methodvespa.querybuilder.builder.builder.Q.any(*conditions:Condition) -> Condition

"Combines multiple conditions with OR operator.

methodvespa.querybuilder.builder.builder.Q.false() -> Condition

Creates a condition that is always false.

method

vespa.querybuilder.builder.builder.Q.geoLocation(field:str, lat:float, lng:float, radius:str, annotations:Optional[Dict[str, Any]]=None) -> Condition

Creates a geolocation search condition.

method

vespa.querybuilder.builder.builder.Q.nearestNeighbor(field:str, query_vector:str, annotations:Dict[str, Any]={'targetHits': 100}) -> Condition

Creates a nearest neighbor search condition.

methodvespa.querybuilder.builder.builder.Q.select(fields:Union[str, List[str], List[QueryField]]) -> Query

Creates a new query selecting specified fields.

methodvespa.querybuilder.builder.builder.Q.true() -> Condition

Creates a condition that is always true.

methodvespa.querybuilder.builder.builder.Q.uri(value:str, annotations:Optional[Dict[str, Any]]=None) -> Condition

Creates a uri operator for matching URIs.

method

vespa.querybuilder.builder.builder.Q.userInput(value:Optional[str]=None, annotations:Optional[Dict[str, Any]]=None) -> Condition

Creates a userInput operator for query evaluation.

methodvespa.querybuilder.builder.builder.Q.userQuery(value:str='') -> Condition

Creates a userQuery operator for text search.

method

vespa.querybuilder.builder.builder.Q.weightedSet(field:str, weights:Union[List[float], Dict[str, float], str], annotations:Optional[Dict[str, Any]]=None) -> Condition

Creates a weighted set condition.

methodvespa.querybuilder.builder.builder.Query.add_parameter(key:str, value:Any) -> Query

Adds a query parameter.

methodvespa.querybuilder.builder.builder.Query.from_(*sources:Union[str, Schema]) -> Query

Specify the source schema(s) to query.

methodvespa.querybuilder.builder.builder.Query.groupby(group_expression:str, continuations:List=[]) -> Query

Groups results by specified expression.

method

vespa.querybuilder.builder.builder.Query.order_by(field:str, ascending:bool=True, annotations:Optional[Dict[str, Any]]=None) -> Query

Orders results by specified fields.

methodvespa.querybuilder.builder.builder.Query.param(key:str, value:Any) -> Query

Alias for add_parameter().

methodvespa.querybuilder.builder.builder.Query.set_limit(limit:int) -> Query

Sets maximum number of results to return.

methodvespa.querybuilder.builder.builder.Query.set_offset(offset:int) -> Query

Sets number of initial results to skip for pagination.

methodvespa.querybuilder.builder.builder.Query.set_timeout(timeout:int) -> Query

Sets query timeout in milliseconds.

methodvespa.querybuilder.builder.builder.Query.where(condition:Union[Condition, bool]) -> Query

Adds a where clause to filter query results.

methodvespa.querybuilder.grouping.grouping.Grouping.add(*expressions:Union[str, Expression]) -> Expression

“add(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.alias(alias_name:str, expression:str) -> str

Defines an alias(...) grouping syntax.

methodvespa.querybuilder.grouping.grouping.Grouping.and_(*expressions:Union[str, Expression]) -> Expression

“and(...)” expression.

method

vespa.querybuilder.grouping.grouping.Grouping.array_at(array_name:str, index_expr:Union[str, int, Expression]) -> Expression

“array.at(...)” accessor expression.

methodvespa.querybuilder.grouping.grouping.Grouping.as_(expression:str, label:str) -> str

Appends an ' as(label)' part to a grouping block expression.

methodvespa.querybuilder.grouping.grouping.Grouping.avg(value:Union[str, int, float]) -> Expression

“avg(...)” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.cat(*expressions:Union[str, Expression]) -> Expression

“cat(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.count() -> Expression

“count()” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.div(*expressions:Union[str, Expression]) -> Expression

“div(...)” expression.

method

vespa.querybuilder.grouping.grouping.Grouping.fixedwidth(value:Union[str, Expression], bucket_width:Union[int, float]) -> Expression

“fixedwidth(...)” bucket expression.

methodvespa.querybuilder.grouping.grouping.Grouping.group(field:str) -> Expression

Defines a grouping step on a field or expression.

method

vespa.querybuilder.grouping.grouping.Grouping.interpolatedlookup(array_attr:Union[str, Expression], lookup_expr:Union[str, Expression]) -> Expression

“interpolatedlookup(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.istrue(expr:str) -> Expression

Creates an ``istrue(...)`` filter predicate.

methodvespa.querybuilder.grouping.grouping.Grouping.math_acos(expr:Union[str, Expression]) -> Expression

“math.acos(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_acosh(expr:Union[str, Expression]) -> Expression

“math.acosh(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_asin(expr:Union[str, Expression]) -> Expression

“math.asin(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_asinh(expr:Union[str, Expression]) -> Expression

“math.asinh(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_atan(expr:Union[str, Expression]) -> Expression

“math.atan(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_atanh(expr:Union[str, Expression]) -> Expression

“math.atanh(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_cbrt(expr:Union[str, Expression]) -> Expression

“math.cbrt(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_cos(expr:Union[str, Expression]) -> Expression

“math.cos(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_cosh(expr:Union[str, Expression]) -> Expression

“math.cosh(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_exp(expr:Union[str, Expression]) -> Expression

“math.exp(...)” expression.

method

vespa.querybuilder.grouping.grouping.Grouping.math_hypot(expr_x:Union[str, Expression], expr_y:Union[str, Expression]) -> Expression

“math.hypot(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_log(expr:Union[str, Expression]) -> Expression

“math.log(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_log10(expr:Union[str, Expression]) -> Expression

“math.log10(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_log1p(expr:Union[str, Expression]) -> Expression

“math.log1p(...)” expression.

method

vespa.querybuilder.grouping.grouping.Grouping.math_pow(expr_x:Union[str, Expression], expr_y:Union[str, Expression]) -> Expression

“math.pow(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_sin(expr:Union[str, Expression]) -> Expression

“math.sin(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_sinh(expr:Union[str, Expression]) -> Expression

“math.sinh(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_sqrt(expr:Union[str, Expression]) -> Expression

“math.sqrt(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_tan(expr:Union[str, Expression]) -> Expression

“math.tan(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.math_tanh(expr:Union[str, Expression]) -> Expression

“math.tanh(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.max(value:Union[str, int, float]) -> Expression

“max(...)” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.md5(expr:Union[str, Expression], width:int) -> Expression

“md5(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.min(value:Union[str, int, float]) -> Expression

“min(...)” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.mod(*expressions:Union[str, Expression]) -> Expression

“mod(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.mul(*expressions:Union[str, Expression]) -> Expression

“mul(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.or_(*expressions:Union[str, Expression]) -> Expression

“or(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.precision(value:int) -> Expression

Sets the “precision(...)” for the grouping step.

methodvespa.querybuilder.grouping.grouping.Grouping.predefined(value:Union[str, Expression], buckets:List[str]) -> Expression

“predefined(...)” bucket expression.

method

vespa.querybuilder.grouping.grouping.Grouping.range_(min_val, max_val, expr:str, lower_inclusive=None, upper_inclusive=None) -> Expression

Creates a ``range(...)`` filter predicate.

methodvespa.querybuilder.grouping.grouping.Grouping.regex(pattern:str, expr:str) -> Expression

Creates a ``regex(...)`` filter predicate.

methodvespa.querybuilder.grouping.grouping.Grouping.relevance() -> Expression

“relevance()” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.reverse(expr:Union[str, Expression]) -> Expression

“reverse(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.size(expr:Union[str, Expression]) -> Expression

“size(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.sort(expr:Union[str, Expression]) -> Expression

“sort(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.stddev(value:Union[str, int, float]) -> Expression

“stddev(...)” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.strcat(*expressions:Union[str, Expression]) -> Expression

“strcat(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.strlen(expr:Union[str, Expression]) -> Expression

“strlen(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.sub(*expressions:Union[str, Expression]) -> Expression

“sub(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.sum(value:Union[str, int, float]) -> Expression

“sum(...)” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.summary(summary_class:str='') -> Expression

“summary(...)” hit aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.time_date(expr:Union[str, Expression]) -> Expression

“time.date(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_dayofmonth(expr:Union[str, Expression]) -> Expression

“time.dayofmonth(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_dayofweek(expr:Union[str, Expression]) -> Expression

“time.dayofweek(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_dayofyear(expr:Union[str, Expression]) -> Expression

“time.dayofyear(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_hourofday(expr:Union[str, Expression]) -> Expression

“time.hourofday(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_minuteofhour(expr:Union[str, Expression]) -> Expression

“time.minuteofhour(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_monthofyear(expr:Union[str, Expression]) -> Expression

“time.monthofyear(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_secondofminute(expr:Union[str, Expression]) -> Expression

“time.secondofminute(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.time_year(expr:Union[str, Expression]) -> Expression

“time.year(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.todouble(expr:Union[str, Expression]) -> Expression

“todouble(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.tolong(expr:Union[str, Expression]) -> Expression

“tolong(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.toraw(expr:Union[str, Expression]) -> Expression

“toraw(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.tostring(expr:Union[str, Expression]) -> Expression

“tostring(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.xor(value:Union[str, int, float]) -> Expression

“xor(...)” aggregator.

methodvespa.querybuilder.grouping.grouping.Grouping.xor_expr(*expressions:Union[str, Expression]) -> Expression

“xor(...)” bitwise expression.

methodvespa.querybuilder.grouping.grouping.Grouping.xorbit(expr:Union[str, Expression], width:int) -> Expression

“xorbit(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.zcurve_x(expr:Union[str, Expression]) -> Expression

“zcurve.x(...)” expression.

methodvespa.querybuilder.grouping.grouping.Grouping.zcurve_y(expr:Union[str, Expression]) -> Expression

“zcurve.y(...)” expression.

funcvespa.validation.to_vespa_identifier(name:str) -> str

Convert a name to a Vespa identifier.

funcvespa.validation.validate_application_name(name:str, legacy_endpoints:bool=False) -> str

Validate a Vespa Cloud application name.

funcvespa.validation.validate_instance_name(name:str) -> str

Validate a Vespa Cloud application instance name.

funcvespa.validation.validate_tenant_name(name:str) -> str

Validate a Vespa Cloud tenant name.

About this data

These signatures were extracted from the public source of vespa-engine/pyvespa using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries