Skip to content

Commit

Permalink
Minor retriever pydoc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
vblagoje committed Jul 8, 2024
1 parent 11a0744 commit 3a3d616
Show file tree
Hide file tree
Showing 13 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def run(self, query_embedding: List[float], filters: Optional[Dict[str, Any]] =
:param query_embedding: floats representing the query embedding
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: the maximum number of documents to retrieve.
:returns: a dictionary with the following keys:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def run(
:param query: The input data for the retriever. In this case, a plain-text query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: The maximum number of documents to retrieve.
If not specified, the default value from the constructor is used.
Expand Down Expand Up @@ -138,7 +138,7 @@ def run(
:param query_embedding: the query embeddings.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: the maximum number of documents to retrieve.
If not specified, the default value from the constructor is used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ def run(self, query: str, filters: Optional[Dict[str, Any]] = None, top_k: Optio
:param query: String to search in `Document`s' text.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of `Document` to return.
:returns: A dictionary with the following keys:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ def run(self, query_embedding: List[float], filters: Optional[Dict[str, Any]] =
:param query_embedding: Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of `Document`s to return.
:returns: A dictionary with the following keys:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def run(
:param query_embedding: Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of Documents to return. Overrides the value specified at initialization.
:returns: A dictionary with the following keys:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def run(
:param query: The query string
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param all_terms_must_match: If True, all terms in the query string must be present in the retrieved documents.
:param top_k: Maximum number of Documents to return.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ def run(
:param query_embedding: Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of Documents to return.
:param custom_query: The query containing a mandatory `$query_embedding` and an optional `$filters` placeholder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def run(
:param query_embedding: Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of Documents to return.
:param vector_function: The similarity function to use when searching for similar embeddings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def run(
:param query: String to search in `Document`s' content.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of Documents to return.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def run(
:param query_embedding: Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: Maximum number of `Document`s to return.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ def run(
:param query_sparse_embedding: Sparse Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: The maximum number of documents to return.
:param scale_score: Whether to scale the scores of the retrieved documents or not.
Expand Down Expand Up @@ -413,7 +413,7 @@ def run(
:param query_embedding: Dense embedding of the query.
:param query_sparse_embedding: Sparse embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k: The maximum number of documents to return.
:param return_embedding: Whether to return the embedding of the retrieved Documents.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def run(self, query: str, filters: Optional[Dict[str, Any]] = None, top_k: Optio
:param query:
The query text.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k:
The maximum number of documents to return.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ def run(
:param query_embedding:
Embedding of the query.
:param filters: Filters applied to the retrieved Documents. The way runtime filters are applied depends on
the `filter_policy` chosen at document store initialization. See init method docstring for more
the `filter_policy` chosen at retriever initialization. See init method docstring for more
details.
:param top_k:
The maximum number of documents to return.
Expand Down

0 comments on commit 3a3d616

Please sign in to comment.