pinecone.core.client.model.hnsw_config
Pinecone API
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501
The version of the OpenAPI document: version not set Contact: support@pinecone.io Generated by: https://openapi-generator.tech
1""" 2 Pinecone API 3 4 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 5 6 The version of the OpenAPI document: version not set 7 Contact: support@pinecone.io 8 Generated by: https://openapi-generator.tech 9""" 10 11 12import re # noqa: F401 13import sys # noqa: F401 14 15from pinecone.core.client.model_utils import ( # noqa: F401 16 ApiTypeError, 17 ModelComposed, 18 ModelNormal, 19 ModelSimple, 20 cached_property, 21 change_keys_js_to_python, 22 convert_js_args_to_python_args, 23 date, 24 datetime, 25 file_type, 26 none_type, 27 validate_get_composed_info, 28) 29from ..model_utils import OpenApiModel 30from pinecone.core.client.exceptions import ApiAttributeError 31 32 33class HnswConfig(ModelNormal): 34 """NOTE: This class is auto generated by OpenAPI Generator. 35 Ref: https://openapi-generator.tech 36 37 Do not edit the class manually. 38 39 Attributes: 40 allowed_values (dict): The key is the tuple path to the attribute 41 and the for var_name this is (var_name,). The value is a dict 42 with a capitalized key describing the allowed value and an allowed 43 value. These dicts store the allowed enum values. 44 attribute_map (dict): The key is attribute name 45 and the value is json key in definition. 46 discriminator_value_class_map (dict): A dict to go from the discriminator 47 variable value to the discriminator class name. 48 validations (dict): The key is the tuple path to the attribute 49 and the for var_name this is (var_name,). The value is a dict 50 that stores validations for max_length, min_length, max_items, 51 min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, 52 inclusive_minimum, and regex. 53 additional_properties_type (tuple): A tuple of classes accepted 54 as additional properties values. 55 """ 56 57 allowed_values = {} 58 59 validations = {} 60 61 @cached_property 62 def additional_properties_type(): 63 """ 64 This must be a method because a model may have properties that are 65 of type self, this must run after the class is loaded 66 """ 67 return ( 68 bool, 69 date, 70 datetime, 71 dict, 72 float, 73 int, 74 list, 75 str, 76 none_type, 77 ) # noqa: E501 78 79 _nullable = False 80 81 @cached_property 82 def openapi_types(): 83 """ 84 This must be a method because a model may have properties that are 85 of type self, this must run after the class is loaded 86 87 Returns 88 openapi_types (dict): The key is attribute name 89 and the value is attribute type. 90 """ 91 return { 92 "ef_construction": (int,), # noqa: E501 93 "ef": (int,), # noqa: E501 94 "m": (int,), # noqa: E501 95 "max_elements": (int,), # noqa: E501 96 } 97 98 @cached_property 99 def discriminator(): 100 return None 101 102 attribute_map = { 103 "ef_construction": "ef_construction", # noqa: E501 104 "ef": "ef", # noqa: E501 105 "m": "M", # noqa: E501 106 "max_elements": "max_elements", # noqa: E501 107 } 108 109 read_only_vars = {} 110 111 _composed_schemas = {} 112 113 @classmethod 114 @convert_js_args_to_python_args 115 def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 116 """HnswConfig - a model defined in OpenAPI 117 118 Keyword Args: 119 _check_type (bool): if True, values for parameters in openapi_types 120 will be type checked and a TypeError will be 121 raised if the wrong type is input. 122 Defaults to True 123 _path_to_item (tuple/list): This is a list of keys or values to 124 drill down to the model in received_data 125 when deserializing a response 126 _spec_property_naming (bool): True if the variable names in the input data 127 are serialized names, as specified in the OpenAPI document. 128 False if the variable names in the input data 129 are pythonic names, e.g. snake case (default) 130 _configuration (Configuration): the instance to use when 131 deserializing a file_type parameter. 132 If passed, type conversion is attempted 133 If omitted no type conversion is done. 134 _visited_composed_classes (tuple): This stores a tuple of 135 classes that we have traveled through so that 136 if we see that class again we will not use its 137 discriminator again. 138 When traveling through a discriminator, the 139 composed schema that is 140 is traveled through is added to this set. 141 For example if Animal has a discriminator 142 petType and we pass in "Dog", and the class Dog 143 allOf includes Animal, we move through Animal 144 once using the discriminator, and pick Dog. 145 Then in Dog, we will make an instance of the 146 Animal class but this time we won't travel 147 through its discriminator because we passed in 148 _visited_composed_classes = (Animal,) 149 ef_construction (int): [optional] if omitted the server will use the default value of 500 # noqa: E501 150 ef (int): [optional] if omitted the server will use the default value of 250 # noqa: E501 151 m (int): [optional] if omitted the server will use the default value of 12 # noqa: E501 152 max_elements (int): [optional] if omitted the server will use the default value of 50000000 # noqa: E501 153 """ 154 155 _check_type = kwargs.pop("_check_type", True) 156 _spec_property_naming = kwargs.pop("_spec_property_naming", False) 157 _path_to_item = kwargs.pop("_path_to_item", ()) 158 _configuration = kwargs.pop("_configuration", None) 159 _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) 160 161 self = super(OpenApiModel, cls).__new__(cls) 162 163 if args: 164 raise ApiTypeError( 165 "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." 166 % ( 167 args, 168 self.__class__.__name__, 169 ), 170 path_to_item=_path_to_item, 171 valid_classes=(self.__class__,), 172 ) 173 174 self._data_store = {} 175 self._check_type = _check_type 176 self._spec_property_naming = _spec_property_naming 177 self._path_to_item = _path_to_item 178 self._configuration = _configuration 179 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) 180 181 for var_name, var_value in kwargs.items(): 182 if ( 183 var_name not in self.attribute_map 184 and self._configuration is not None 185 and self._configuration.discard_unknown_keys 186 and self.additional_properties_type is None 187 ): 188 # discard variable. 189 continue 190 setattr(self, var_name, var_value) 191 return self 192 193 required_properties = set( 194 [ 195 "_data_store", 196 "_check_type", 197 "_spec_property_naming", 198 "_path_to_item", 199 "_configuration", 200 "_visited_composed_classes", 201 ] 202 ) 203 204 @convert_js_args_to_python_args 205 def __init__(self, *args, **kwargs): # noqa: E501 206 """HnswConfig - a model defined in OpenAPI 207 208 Keyword Args: 209 _check_type (bool): if True, values for parameters in openapi_types 210 will be type checked and a TypeError will be 211 raised if the wrong type is input. 212 Defaults to True 213 _path_to_item (tuple/list): This is a list of keys or values to 214 drill down to the model in received_data 215 when deserializing a response 216 _spec_property_naming (bool): True if the variable names in the input data 217 are serialized names, as specified in the OpenAPI document. 218 False if the variable names in the input data 219 are pythonic names, e.g. snake case (default) 220 _configuration (Configuration): the instance to use when 221 deserializing a file_type parameter. 222 If passed, type conversion is attempted 223 If omitted no type conversion is done. 224 _visited_composed_classes (tuple): This stores a tuple of 225 classes that we have traveled through so that 226 if we see that class again we will not use its 227 discriminator again. 228 When traveling through a discriminator, the 229 composed schema that is 230 is traveled through is added to this set. 231 For example if Animal has a discriminator 232 petType and we pass in "Dog", and the class Dog 233 allOf includes Animal, we move through Animal 234 once using the discriminator, and pick Dog. 235 Then in Dog, we will make an instance of the 236 Animal class but this time we won't travel 237 through its discriminator because we passed in 238 _visited_composed_classes = (Animal,) 239 ef_construction (int): [optional] if omitted the server will use the default value of 500 # noqa: E501 240 ef (int): [optional] if omitted the server will use the default value of 250 # noqa: E501 241 m (int): [optional] if omitted the server will use the default value of 12 # noqa: E501 242 max_elements (int): [optional] if omitted the server will use the default value of 50000000 # noqa: E501 243 """ 244 245 _check_type = kwargs.pop("_check_type", True) 246 _spec_property_naming = kwargs.pop("_spec_property_naming", False) 247 _path_to_item = kwargs.pop("_path_to_item", ()) 248 _configuration = kwargs.pop("_configuration", None) 249 _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) 250 251 if args: 252 raise ApiTypeError( 253 "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." 254 % ( 255 args, 256 self.__class__.__name__, 257 ), 258 path_to_item=_path_to_item, 259 valid_classes=(self.__class__,), 260 ) 261 262 self._data_store = {} 263 self._check_type = _check_type 264 self._spec_property_naming = _spec_property_naming 265 self._path_to_item = _path_to_item 266 self._configuration = _configuration 267 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) 268 269 for var_name, var_value in kwargs.items(): 270 if ( 271 var_name not in self.attribute_map 272 and self._configuration is not None 273 and self._configuration.discard_unknown_keys 274 and self.additional_properties_type is None 275 ): 276 # discard variable. 277 continue 278 setattr(self, var_name, var_value) 279 if var_name in self.read_only_vars: 280 raise ApiAttributeError( 281 f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " 282 f"class with read only attributes." 283 )
34class HnswConfig(ModelNormal): 35 """NOTE: This class is auto generated by OpenAPI Generator. 36 Ref: https://openapi-generator.tech 37 38 Do not edit the class manually. 39 40 Attributes: 41 allowed_values (dict): The key is the tuple path to the attribute 42 and the for var_name this is (var_name,). The value is a dict 43 with a capitalized key describing the allowed value and an allowed 44 value. These dicts store the allowed enum values. 45 attribute_map (dict): The key is attribute name 46 and the value is json key in definition. 47 discriminator_value_class_map (dict): A dict to go from the discriminator 48 variable value to the discriminator class name. 49 validations (dict): The key is the tuple path to the attribute 50 and the for var_name this is (var_name,). The value is a dict 51 that stores validations for max_length, min_length, max_items, 52 min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, 53 inclusive_minimum, and regex. 54 additional_properties_type (tuple): A tuple of classes accepted 55 as additional properties values. 56 """ 57 58 allowed_values = {} 59 60 validations = {} 61 62 @cached_property 63 def additional_properties_type(): 64 """ 65 This must be a method because a model may have properties that are 66 of type self, this must run after the class is loaded 67 """ 68 return ( 69 bool, 70 date, 71 datetime, 72 dict, 73 float, 74 int, 75 list, 76 str, 77 none_type, 78 ) # noqa: E501 79 80 _nullable = False 81 82 @cached_property 83 def openapi_types(): 84 """ 85 This must be a method because a model may have properties that are 86 of type self, this must run after the class is loaded 87 88 Returns 89 openapi_types (dict): The key is attribute name 90 and the value is attribute type. 91 """ 92 return { 93 "ef_construction": (int,), # noqa: E501 94 "ef": (int,), # noqa: E501 95 "m": (int,), # noqa: E501 96 "max_elements": (int,), # noqa: E501 97 } 98 99 @cached_property 100 def discriminator(): 101 return None 102 103 attribute_map = { 104 "ef_construction": "ef_construction", # noqa: E501 105 "ef": "ef", # noqa: E501 106 "m": "M", # noqa: E501 107 "max_elements": "max_elements", # noqa: E501 108 } 109 110 read_only_vars = {} 111 112 _composed_schemas = {} 113 114 @classmethod 115 @convert_js_args_to_python_args 116 def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 117 """HnswConfig - a model defined in OpenAPI 118 119 Keyword Args: 120 _check_type (bool): if True, values for parameters in openapi_types 121 will be type checked and a TypeError will be 122 raised if the wrong type is input. 123 Defaults to True 124 _path_to_item (tuple/list): This is a list of keys or values to 125 drill down to the model in received_data 126 when deserializing a response 127 _spec_property_naming (bool): True if the variable names in the input data 128 are serialized names, as specified in the OpenAPI document. 129 False if the variable names in the input data 130 are pythonic names, e.g. snake case (default) 131 _configuration (Configuration): the instance to use when 132 deserializing a file_type parameter. 133 If passed, type conversion is attempted 134 If omitted no type conversion is done. 135 _visited_composed_classes (tuple): This stores a tuple of 136 classes that we have traveled through so that 137 if we see that class again we will not use its 138 discriminator again. 139 When traveling through a discriminator, the 140 composed schema that is 141 is traveled through is added to this set. 142 For example if Animal has a discriminator 143 petType and we pass in "Dog", and the class Dog 144 allOf includes Animal, we move through Animal 145 once using the discriminator, and pick Dog. 146 Then in Dog, we will make an instance of the 147 Animal class but this time we won't travel 148 through its discriminator because we passed in 149 _visited_composed_classes = (Animal,) 150 ef_construction (int): [optional] if omitted the server will use the default value of 500 # noqa: E501 151 ef (int): [optional] if omitted the server will use the default value of 250 # noqa: E501 152 m (int): [optional] if omitted the server will use the default value of 12 # noqa: E501 153 max_elements (int): [optional] if omitted the server will use the default value of 50000000 # noqa: E501 154 """ 155 156 _check_type = kwargs.pop("_check_type", True) 157 _spec_property_naming = kwargs.pop("_spec_property_naming", False) 158 _path_to_item = kwargs.pop("_path_to_item", ()) 159 _configuration = kwargs.pop("_configuration", None) 160 _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) 161 162 self = super(OpenApiModel, cls).__new__(cls) 163 164 if args: 165 raise ApiTypeError( 166 "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." 167 % ( 168 args, 169 self.__class__.__name__, 170 ), 171 path_to_item=_path_to_item, 172 valid_classes=(self.__class__,), 173 ) 174 175 self._data_store = {} 176 self._check_type = _check_type 177 self._spec_property_naming = _spec_property_naming 178 self._path_to_item = _path_to_item 179 self._configuration = _configuration 180 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) 181 182 for var_name, var_value in kwargs.items(): 183 if ( 184 var_name not in self.attribute_map 185 and self._configuration is not None 186 and self._configuration.discard_unknown_keys 187 and self.additional_properties_type is None 188 ): 189 # discard variable. 190 continue 191 setattr(self, var_name, var_value) 192 return self 193 194 required_properties = set( 195 [ 196 "_data_store", 197 "_check_type", 198 "_spec_property_naming", 199 "_path_to_item", 200 "_configuration", 201 "_visited_composed_classes", 202 ] 203 ) 204 205 @convert_js_args_to_python_args 206 def __init__(self, *args, **kwargs): # noqa: E501 207 """HnswConfig - a model defined in OpenAPI 208 209 Keyword Args: 210 _check_type (bool): if True, values for parameters in openapi_types 211 will be type checked and a TypeError will be 212 raised if the wrong type is input. 213 Defaults to True 214 _path_to_item (tuple/list): This is a list of keys or values to 215 drill down to the model in received_data 216 when deserializing a response 217 _spec_property_naming (bool): True if the variable names in the input data 218 are serialized names, as specified in the OpenAPI document. 219 False if the variable names in the input data 220 are pythonic names, e.g. snake case (default) 221 _configuration (Configuration): the instance to use when 222 deserializing a file_type parameter. 223 If passed, type conversion is attempted 224 If omitted no type conversion is done. 225 _visited_composed_classes (tuple): This stores a tuple of 226 classes that we have traveled through so that 227 if we see that class again we will not use its 228 discriminator again. 229 When traveling through a discriminator, the 230 composed schema that is 231 is traveled through is added to this set. 232 For example if Animal has a discriminator 233 petType and we pass in "Dog", and the class Dog 234 allOf includes Animal, we move through Animal 235 once using the discriminator, and pick Dog. 236 Then in Dog, we will make an instance of the 237 Animal class but this time we won't travel 238 through its discriminator because we passed in 239 _visited_composed_classes = (Animal,) 240 ef_construction (int): [optional] if omitted the server will use the default value of 500 # noqa: E501 241 ef (int): [optional] if omitted the server will use the default value of 250 # noqa: E501 242 m (int): [optional] if omitted the server will use the default value of 12 # noqa: E501 243 max_elements (int): [optional] if omitted the server will use the default value of 50000000 # noqa: E501 244 """ 245 246 _check_type = kwargs.pop("_check_type", True) 247 _spec_property_naming = kwargs.pop("_spec_property_naming", False) 248 _path_to_item = kwargs.pop("_path_to_item", ()) 249 _configuration = kwargs.pop("_configuration", None) 250 _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) 251 252 if args: 253 raise ApiTypeError( 254 "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." 255 % ( 256 args, 257 self.__class__.__name__, 258 ), 259 path_to_item=_path_to_item, 260 valid_classes=(self.__class__,), 261 ) 262 263 self._data_store = {} 264 self._check_type = _check_type 265 self._spec_property_naming = _spec_property_naming 266 self._path_to_item = _path_to_item 267 self._configuration = _configuration 268 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) 269 270 for var_name, var_value in kwargs.items(): 271 if ( 272 var_name not in self.attribute_map 273 and self._configuration is not None 274 and self._configuration.discard_unknown_keys 275 and self.additional_properties_type is None 276 ): 277 # discard variable. 278 continue 279 setattr(self, var_name, var_value) 280 if var_name in self.read_only_vars: 281 raise ApiAttributeError( 282 f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " 283 f"class with read only attributes." 284 )
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
Attributes:
- allowed_values (dict): The key is the tuple path to the attribute and the for var_name this is (var_name,). The value is a dict with a capitalized key describing the allowed value and an allowed value. These dicts store the allowed enum values.
- attribute_map (dict): The key is attribute name and the value is json key in definition.
- discriminator_value_class_map (dict): A dict to go from the discriminator variable value to the discriminator class name.
- validations (dict): The key is the tuple path to the attribute and the for var_name this is (var_name,). The value is a dict that stores validations for max_length, min_length, max_items, min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, inclusive_minimum, and regex.
- additional_properties_type (tuple): A tuple of classes accepted as additional properties values.
@convert_js_args_to_python_args
HnswConfig(*args, **kwargs)
205 @convert_js_args_to_python_args 206 def __init__(self, *args, **kwargs): # noqa: E501 207 """HnswConfig - a model defined in OpenAPI 208 209 Keyword Args: 210 _check_type (bool): if True, values for parameters in openapi_types 211 will be type checked and a TypeError will be 212 raised if the wrong type is input. 213 Defaults to True 214 _path_to_item (tuple/list): This is a list of keys or values to 215 drill down to the model in received_data 216 when deserializing a response 217 _spec_property_naming (bool): True if the variable names in the input data 218 are serialized names, as specified in the OpenAPI document. 219 False if the variable names in the input data 220 are pythonic names, e.g. snake case (default) 221 _configuration (Configuration): the instance to use when 222 deserializing a file_type parameter. 223 If passed, type conversion is attempted 224 If omitted no type conversion is done. 225 _visited_composed_classes (tuple): This stores a tuple of 226 classes that we have traveled through so that 227 if we see that class again we will not use its 228 discriminator again. 229 When traveling through a discriminator, the 230 composed schema that is 231 is traveled through is added to this set. 232 For example if Animal has a discriminator 233 petType and we pass in "Dog", and the class Dog 234 allOf includes Animal, we move through Animal 235 once using the discriminator, and pick Dog. 236 Then in Dog, we will make an instance of the 237 Animal class but this time we won't travel 238 through its discriminator because we passed in 239 _visited_composed_classes = (Animal,) 240 ef_construction (int): [optional] if omitted the server will use the default value of 500 # noqa: E501 241 ef (int): [optional] if omitted the server will use the default value of 250 # noqa: E501 242 m (int): [optional] if omitted the server will use the default value of 12 # noqa: E501 243 max_elements (int): [optional] if omitted the server will use the default value of 50000000 # noqa: E501 244 """ 245 246 _check_type = kwargs.pop("_check_type", True) 247 _spec_property_naming = kwargs.pop("_spec_property_naming", False) 248 _path_to_item = kwargs.pop("_path_to_item", ()) 249 _configuration = kwargs.pop("_configuration", None) 250 _visited_composed_classes = kwargs.pop("_visited_composed_classes", ()) 251 252 if args: 253 raise ApiTypeError( 254 "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." 255 % ( 256 args, 257 self.__class__.__name__, 258 ), 259 path_to_item=_path_to_item, 260 valid_classes=(self.__class__,), 261 ) 262 263 self._data_store = {} 264 self._check_type = _check_type 265 self._spec_property_naming = _spec_property_naming 266 self._path_to_item = _path_to_item 267 self._configuration = _configuration 268 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) 269 270 for var_name, var_value in kwargs.items(): 271 if ( 272 var_name not in self.attribute_map 273 and self._configuration is not None 274 and self._configuration.discard_unknown_keys 275 and self.additional_properties_type is None 276 ): 277 # discard variable. 278 continue 279 setattr(self, var_name, var_value) 280 if var_name in self.read_only_vars: 281 raise ApiAttributeError( 282 f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " 283 f"class with read only attributes." 284 )
HnswConfig - a model defined in OpenAPI
Keyword Args:
_check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True _path_to_item (tuple/list): This is a list of keys or values to drill down to the model in received_data when deserializing a response _spec_property_naming (bool): True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default) _configuration (Configuration): the instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done. _visited_composed_classes (tuple): This stores a tuple of classes that we have traveled through so that if we see that class again we will not use its discriminator again. When traveling through a discriminator, the composed schema that is is traveled through is added to this set. For example if Animal has a discriminator petType and we pass in "Dog", and the class Dog allOf includes Animal, we move through Animal once using the discriminator, and pick Dog. Then in Dog, we will make an instance of the Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) ef_construction (int): [optional] if omitted the server will use the default value of 500 # noqa: E501 ef (int): [optional] if omitted the server will use the default value of 250 # noqa: E501 m (int): [optional] if omitted the server will use the default value of 12 # noqa: E501 max_elements (int): [optional] if omitted the server will use the default value of 50000000 # noqa: E501
def
additional_properties_type(unknown):
This must be a method because a model may have properties that are of type self, this must run after the class is loaded
def
openapi_types(unknown):
This must be a method because a model may have properties that are of type self, this must run after the class is loaded
Returns openapi_types (dict): The key is attribute name and the value is attribute type.
attribute_map =
{'ef_construction': 'ef_construction', 'ef': 'ef', 'm': 'M', 'max_elements': 'max_elements'}