pinecone.data.types.search_query_typed_dict 

 1from typing import TypedDict, Optional, Union, Dict, Any
 2from .search_query_vector_typed_dict import SearchQueryVectorTypedDict
 3
 4
 5class SearchQueryTypedDict(TypedDict):
 6    """
 7    SearchQuery represents the query when searching within a specific namespace.
 8    """
 9
10    inputs: Dict[str, Any]
11    """
12    The input data to search with.
13    Required.
14    """
15
16    top_k: int
17    """
18    The number of results to return with each search.
19    Required.
20    """
21
22    filter: Optional[Dict[str, Any]]
23    """
24    The filter to apply to the search.
25    Optional.
26    """
27
28    vector: Optional[Union[SearchQueryVectorTypedDict]]
29    """
30    The vector values to search with. If provided, it overwrites the inputs.
31    """
32
33    id: Optional[str]
34    """
35    The unique ID of the vector to be used as a query vector.
36    """
class SearchQueryTypedDict(typing.TypedDict): 
 6class SearchQueryTypedDict(TypedDict):
 7    """
 8    SearchQuery represents the query when searching within a specific namespace.
 9    """
10
11    inputs: Dict[str, Any]
12    """
13    The input data to search with.
14    Required.
15    """
16
17    top_k: int
18    """
19    The number of results to return with each search.
20    Required.
21    """
22
23    filter: Optional[Dict[str, Any]]
24    """
25    The filter to apply to the search.
26    Optional.
27    """
28
29    vector: Optional[Union[SearchQueryVectorTypedDict]]
30    """
31    The vector values to search with. If provided, it overwrites the inputs.
32    """
33
34    id: Optional[str]
35    """
36    The unique ID of the vector to be used as a query vector.
37    """

SearchQuery represents the query when searching within a specific namespace.

inputs: Dict[str, Any]

The input data to search with. Required.

top_k: int

The number of results to return with each search. Required.

filter: Optional[Dict[str, Any]]

The filter to apply to the search. Optional.

vector: Optional[pinecone.data.types.search_query_vector_typed_dict.SearchQueryVectorTypedDict]

The vector values to search with. If provided, it overwrites the inputs.

id: Optional[str]

The unique ID of the vector to be used as a query vector.