@@ -2058,9 +2058,9 @@ def federated_query_notices(self,
20582058 def get_autocompletion(self,
20592059 environment_id,
20602060 collection_id,
2061+ prefix,
20612062 *,
20622063 field=None,
2063- prefix=None,
20642064 count=None,
20652065 **kwargs):
20662066 """
@@ -2072,11 +2072,11 @@ def get_autocompletion(self,
20722072
20732073 :param str environment_id: The ID of the environment.
20742074 :param str collection_id: The ID of the collection.
2075+ :param str prefix: The prefix to use for autocompletion. For example, the
2076+ prefix `Ho` could autocomplete to `Hot`, `Housing`, or `How do I upgrade`.
2077+ Possible completions are.
20752078 :param str field: (optional) The field in the result documents that
20762079 autocompletion suggestions are identified from.
2077- :param str prefix: (optional) The prefix to use for autocompletion. For
2078- example, the prefix `Ho` could autocomplete to `Hot`, `Housing`, or `How do
2079- I upgrade`. Possible completions are.
20802080 :param int count: (optional) The number of autocompletion suggestions to
20812081 return.
20822082 :param dict headers: A `dict` containing the request headers
@@ -2088,6 +2088,8 @@ def get_autocompletion(self,
20882088 raise ValueError('environment_id must be provided')
20892089 if collection_id is None:
20902090 raise ValueError('collection_id must be provided')
2091+ if prefix is None:
2092+ raise ValueError('prefix must be provided')
20912093
20922094 headers = {}
20932095 if 'headers' in kwargs:
@@ -2097,8 +2099,8 @@ def get_autocompletion(self,
20972099
20982100 params = {
20992101 'version': self.version,
2100- 'field': field,
21012102 'prefix': prefix,
2103+ 'field': field,
21022104 'count': count
21032105 }
21042106
@@ -9938,6 +9940,8 @@ class QueryResponse():
99389940 **Important:** Session tokens are case sensitive.
99399941 :attr RetrievalDetails retrieval_details: (optional) An object contain retrieval
99409942 type information.
9943+ :attr str suggested_query: (optional) The suggestions for a misspelled natural
9944+ language query.
99419945 """
99429946
99439947 def __init__(self,
@@ -9948,7 +9952,8 @@ def __init__(self,
99489952 passages=None,
99499953 duplicates_removed=None,
99509954 session_token=None,
9951- retrieval_details=None):
9955+ retrieval_details=None,
9956+ suggested_query=None):
99529957 """
99539958 Initialize a QueryResponse object.
99549959
@@ -9968,6 +9973,8 @@ def __init__(self,
99689973 **Important:** Session tokens are case sensitive.
99699974 :param RetrievalDetails retrieval_details: (optional) An object contain
99709975 retrieval type information.
9976+ :param str suggested_query: (optional) The suggestions for a misspelled
9977+ natural language query.
99719978 """
99729979 self.matching_results = matching_results
99739980 self.results = results
@@ -9976,14 +9983,16 @@ def __init__(self,
99769983 self.duplicates_removed = duplicates_removed
99779984 self.session_token = session_token
99789985 self.retrieval_details = retrieval_details
9986+ self.suggested_query = suggested_query
99799987
99809988 @classmethod
99819989 def _from_dict(cls, _dict):
99829990 """Initialize a QueryResponse object from a json dictionary."""
99839991 args = {}
99849992 valid_keys = [
99859993 'matching_results', 'results', 'aggregations', 'passages',
9986- 'duplicates_removed', 'session_token', 'retrieval_details'
9994+ 'duplicates_removed', 'session_token', 'retrieval_details',
9995+ 'suggested_query'
99879996 ]
99889997 bad_keys = set(_dict.keys()) - set(valid_keys)
99899998 if bad_keys:
@@ -10012,6 +10021,8 @@ def _from_dict(cls, _dict):
1001210021 if 'retrieval_details' in _dict:
1001310022 args['retrieval_details'] = RetrievalDetails._from_dict(
1001410023 _dict.get('retrieval_details'))
10024+ if 'suggested_query' in _dict:
10025+ args['suggested_query'] = _dict.get('suggested_query')
1001510026 return cls(**args)
1001610027
1001710028 def _to_dict(self):
@@ -10035,6 +10046,9 @@ def _to_dict(self):
1003510046 if hasattr(self,
1003610047 'retrieval_details') and self.retrieval_details is not None:
1003710048 _dict['retrieval_details'] = self.retrieval_details._to_dict()
10049+ if hasattr(self,
10050+ 'suggested_query') and self.suggested_query is not None:
10051+ _dict['suggested_query'] = self.suggested_query
1003810052 return _dict
1003910053
1004010054 def __str__(self):
0 commit comments