fds.sdk.VectorData 0.0.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. fds/__init__.py +0 -0
  2. fds/sdk/VectorData/__init__.py +28 -0
  3. fds/sdk/VectorData/api/__init__.py +3 -0
  4. fds/sdk/VectorData/api/meta_api.py +959 -0
  5. fds/sdk/VectorData/api/vector_api.py +564 -0
  6. fds/sdk/VectorData/api_client.py +939 -0
  7. fds/sdk/VectorData/apis/__init__.py +18 -0
  8. fds/sdk/VectorData/configuration.py +496 -0
  9. fds/sdk/VectorData/exceptions.py +160 -0
  10. fds/sdk/VectorData/model/__init__.py +5 -0
  11. fds/sdk/VectorData/model/chunk_text_response.py +268 -0
  12. fds/sdk/VectorData/model/chunk_text_response_meta.py +262 -0
  13. fds/sdk/VectorData/model/chunk_text_response_meta_pagination.py +260 -0
  14. fds/sdk/VectorData/model/chunk_text_result.py +284 -0
  15. fds/sdk/VectorData/model/document_types.py +268 -0
  16. fds/sdk/VectorData/model/document_types_response.py +262 -0
  17. fds/sdk/VectorData/model/error_object.py +268 -0
  18. fds/sdk/VectorData/model/error_response.py +262 -0
  19. fds/sdk/VectorData/model/meta.py +260 -0
  20. fds/sdk/VectorData/model/schemas.py +274 -0
  21. fds/sdk/VectorData/model/schemas_response.py +262 -0
  22. fds/sdk/VectorData/model/source.py +268 -0
  23. fds/sdk/VectorData/model/source_response.py +262 -0
  24. fds/sdk/VectorData/model/themes.py +274 -0
  25. fds/sdk/VectorData/model/themes_response.py +262 -0
  26. fds/sdk/VectorData/model/vector_data_request.py +274 -0
  27. fds/sdk/VectorData/model/vector_data_request_data.py +313 -0
  28. fds/sdk/VectorData/model/vector_data_response.py +268 -0
  29. fds/sdk/VectorData/model/vector_data_response_meta.py +256 -0
  30. fds/sdk/VectorData/model/vector_data_result.py +296 -0
  31. fds/sdk/VectorData/model_utils.py +2062 -0
  32. fds/sdk/VectorData/models/__init__.py +31 -0
  33. fds/sdk/VectorData/rest.py +347 -0
  34. fds/sdk/__init__.py +0 -0
  35. fds_sdk_vectordata-0.0.1.dist-info/METADATA +349 -0
  36. fds_sdk_vectordata-0.0.1.dist-info/RECORD +39 -0
  37. fds_sdk_vectordata-0.0.1.dist-info/WHEEL +5 -0
  38. fds_sdk_vectordata-0.0.1.dist-info/licenses/LICENSE +202 -0
  39. fds_sdk_vectordata-0.0.1.dist-info/top_level.txt +1 -0
@@ -0,0 +1,262 @@
1
+ """
2
+ Vector Data API
3
+
4
+ The Vector Data API provides streamlined access to vector data through its defined endpoints. It supports functionalities such as: Retrieving detailed vector data based on user-defined parameters. Efficiently processing associated text data for enhanced performance. This API is designed to enable developers to integrate vector data into their applications, ensuring flexibility and performance while leveraging the specified endpoint functionalities. # noqa: E501
5
+
6
+ The version of the OpenAPI document: 0.0.0
7
+ Contact: api@factset.com
8
+ Generated by: https://openapi-generator.tech
9
+ """
10
+
11
+
12
+ import re # noqa: F401
13
+ import sys # noqa: F401
14
+
15
+ from fds.sdk.VectorData.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
+ OpenApiModel
29
+ )
30
+ from fds.sdk.VectorData.exceptions import ApiAttributeError
31
+
32
+
33
+ def lazy_import():
34
+ from fds.sdk.VectorData.model.source import Source
35
+ globals()['Source'] = Source
36
+
37
+
38
+ class SourceResponse(ModelNormal):
39
+ """NOTE: This class is auto generated by OpenAPI Generator.
40
+ Ref: https://openapi-generator.tech
41
+
42
+ Do not edit the class manually.
43
+
44
+ Attributes:
45
+ allowed_values (dict): The key is the tuple path to the attribute
46
+ and the for var_name this is (var_name,). The value is a dict
47
+ with a capitalized key describing the allowed value and an allowed
48
+ value. These dicts store the allowed enum values.
49
+ attribute_map (dict): The key is attribute name
50
+ and the value is json key in definition.
51
+ discriminator_value_class_map (dict): A dict to go from the discriminator
52
+ variable value to the discriminator class name.
53
+ validations (dict): The key is the tuple path to the attribute
54
+ and the for var_name this is (var_name,). The value is a dict
55
+ that stores validations for max_length, min_length, max_items,
56
+ min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
57
+ inclusive_minimum, and regex.
58
+ additional_properties_type (tuple): A tuple of classes accepted
59
+ as additional properties values.
60
+ """
61
+
62
+ allowed_values = {
63
+ }
64
+
65
+ validations = {
66
+ }
67
+
68
+ @cached_property
69
+ def additional_properties_type():
70
+ """
71
+ This must be a method because a model may have properties that are
72
+ of type self, this must run after the class is loaded
73
+ """
74
+ lazy_import()
75
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
76
+
77
+ _nullable = False
78
+
79
+ @cached_property
80
+ def openapi_types():
81
+ """
82
+ This must be a method because a model may have properties that are
83
+ of type self, this must run after the class is loaded
84
+
85
+ Returns
86
+ openapi_types (dict): The key is attribute name
87
+ and the value is attribute type.
88
+ """
89
+ lazy_import()
90
+ return {
91
+ 'data': ([Source],), # noqa: E501
92
+ }
93
+
94
+ @cached_property
95
+ def discriminator():
96
+ return None
97
+
98
+
99
+ attribute_map = {
100
+ 'data': 'data', # noqa: E501
101
+ }
102
+
103
+ read_only_vars = {
104
+ }
105
+
106
+ _composed_schemas = {}
107
+
108
+ @classmethod
109
+ @convert_js_args_to_python_args
110
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
111
+ """SourceResponse - a model defined in OpenAPI
112
+
113
+ Keyword Args:
114
+ _check_type (bool): if True, values for parameters in openapi_types
115
+ will be type checked and a TypeError will be
116
+ raised if the wrong type is input.
117
+ Defaults to True
118
+ _path_to_item (tuple/list): This is a list of keys or values to
119
+ drill down to the model in received_data
120
+ when deserializing a response
121
+ _spec_property_naming (bool): True if the variable names in the input data
122
+ are serialized names, as specified in the OpenAPI document.
123
+ False if the variable names in the input data
124
+ are pythonic names, e.g. snake case (default)
125
+ _configuration (Configuration): the instance to use when
126
+ deserializing a file_type parameter.
127
+ If passed, type conversion is attempted
128
+ If omitted no type conversion is done.
129
+ _visited_composed_classes (tuple): This stores a tuple of
130
+ classes that we have traveled through so that
131
+ if we see that class again we will not use its
132
+ discriminator again.
133
+ When traveling through a discriminator, the
134
+ composed schema that is
135
+ is traveled through is added to this set.
136
+ For example if Animal has a discriminator
137
+ petType and we pass in "Dog", and the class Dog
138
+ allOf includes Animal, we move through Animal
139
+ once using the discriminator, and pick Dog.
140
+ Then in Dog, we will make an instance of the
141
+ Animal class but this time we won't travel
142
+ through its discriminator because we passed in
143
+ _visited_composed_classes = (Animal,)
144
+ data ([Source]): List of available sources. [optional] # noqa: E501
145
+ """
146
+
147
+ _check_type = kwargs.pop('_check_type', True)
148
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
149
+ _path_to_item = kwargs.pop('_path_to_item', ())
150
+ _configuration = kwargs.pop('_configuration', None)
151
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
152
+
153
+ self = super(OpenApiModel, cls).__new__(cls)
154
+
155
+ if args:
156
+ raise ApiTypeError(
157
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
158
+ args,
159
+ self.__class__.__name__,
160
+ ),
161
+ path_to_item=_path_to_item,
162
+ valid_classes=(self.__class__,),
163
+ )
164
+
165
+ self._data_store = {}
166
+ self._check_type = _check_type
167
+ self._spec_property_naming = _spec_property_naming
168
+ self._path_to_item = _path_to_item
169
+ self._configuration = _configuration
170
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
171
+
172
+ for var_name, var_value in kwargs.items():
173
+ if var_name not in self.attribute_map and \
174
+ self._configuration is not None and \
175
+ self._configuration.discard_unknown_keys and \
176
+ self.additional_properties_type is None:
177
+ # discard variable.
178
+ continue
179
+ setattr(self, var_name, var_value)
180
+ return self
181
+
182
+ required_properties = set([
183
+ '_data_store',
184
+ '_check_type',
185
+ '_spec_property_naming',
186
+ '_path_to_item',
187
+ '_configuration',
188
+ '_visited_composed_classes',
189
+ ])
190
+
191
+ @convert_js_args_to_python_args
192
+ def __init__(self, *args, **kwargs): # noqa: E501
193
+ """SourceResponse - a model defined in OpenAPI
194
+
195
+ Keyword Args:
196
+ _check_type (bool): if True, values for parameters in openapi_types
197
+ will be type checked and a TypeError will be
198
+ raised if the wrong type is input.
199
+ Defaults to True
200
+ _path_to_item (tuple/list): This is a list of keys or values to
201
+ drill down to the model in received_data
202
+ when deserializing a response
203
+ _spec_property_naming (bool): True if the variable names in the input data
204
+ are serialized names, as specified in the OpenAPI document.
205
+ False if the variable names in the input data
206
+ are pythonic names, e.g. snake case (default)
207
+ _configuration (Configuration): the instance to use when
208
+ deserializing a file_type parameter.
209
+ If passed, type conversion is attempted
210
+ If omitted no type conversion is done.
211
+ _visited_composed_classes (tuple): This stores a tuple of
212
+ classes that we have traveled through so that
213
+ if we see that class again we will not use its
214
+ discriminator again.
215
+ When traveling through a discriminator, the
216
+ composed schema that is
217
+ is traveled through is added to this set.
218
+ For example if Animal has a discriminator
219
+ petType and we pass in "Dog", and the class Dog
220
+ allOf includes Animal, we move through Animal
221
+ once using the discriminator, and pick Dog.
222
+ Then in Dog, we will make an instance of the
223
+ Animal class but this time we won't travel
224
+ through its discriminator because we passed in
225
+ _visited_composed_classes = (Animal,)
226
+ data ([Source]): List of available sources. [optional] # noqa: E501
227
+ """
228
+
229
+ _check_type = kwargs.pop('_check_type', True)
230
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
231
+ _path_to_item = kwargs.pop('_path_to_item', ())
232
+ _configuration = kwargs.pop('_configuration', None)
233
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
234
+
235
+ if args:
236
+ raise ApiTypeError(
237
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
238
+ args,
239
+ self.__class__.__name__,
240
+ ),
241
+ path_to_item=_path_to_item,
242
+ valid_classes=(self.__class__,),
243
+ )
244
+
245
+ self._data_store = {}
246
+ self._check_type = _check_type
247
+ self._spec_property_naming = _spec_property_naming
248
+ self._path_to_item = _path_to_item
249
+ self._configuration = _configuration
250
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
251
+
252
+ for var_name, var_value in kwargs.items():
253
+ if var_name not in self.attribute_map and \
254
+ self._configuration is not None and \
255
+ self._configuration.discard_unknown_keys and \
256
+ self.additional_properties_type is None:
257
+ # discard variable.
258
+ continue
259
+ setattr(self, var_name, var_value)
260
+ if var_name in self.read_only_vars:
261
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
262
+ f"class with read only attributes.")
@@ -0,0 +1,274 @@
1
+ """
2
+ Vector Data API
3
+
4
+ The Vector Data API provides streamlined access to vector data through its defined endpoints. It supports functionalities such as: Retrieving detailed vector data based on user-defined parameters. Efficiently processing associated text data for enhanced performance. This API is designed to enable developers to integrate vector data into their applications, ensuring flexibility and performance while leveraging the specified endpoint functionalities. # noqa: E501
5
+
6
+ The version of the OpenAPI document: 0.0.0
7
+ Contact: api@factset.com
8
+ Generated by: https://openapi-generator.tech
9
+ """
10
+
11
+
12
+ import re # noqa: F401
13
+ import sys # noqa: F401
14
+
15
+ from fds.sdk.VectorData.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
+ OpenApiModel
29
+ )
30
+ from fds.sdk.VectorData.exceptions import ApiAttributeError
31
+
32
+
33
+
34
+ class Themes(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
+
61
+ validations = {
62
+ }
63
+
64
+ @cached_property
65
+ def additional_properties_type():
66
+ """
67
+ This must be a method because a model may have properties that are
68
+ of type self, this must run after the class is loaded
69
+ """
70
+ return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
71
+
72
+ _nullable = False
73
+
74
+ @cached_property
75
+ def openapi_types():
76
+ """
77
+ This must be a method because a model may have properties that are
78
+ of type self, this must run after the class is loaded
79
+
80
+ Returns
81
+ openapi_types (dict): The key is attribute name
82
+ and the value is attribute type.
83
+ """
84
+ return {
85
+ 'description': (str,), # noqa: E501
86
+ 'esg_theme': (str,), # noqa: E501
87
+ 'search_concept': (str,), # noqa: E501
88
+ 'sentiment': (str,), # noqa: E501
89
+ }
90
+
91
+ @cached_property
92
+ def discriminator():
93
+ return None
94
+
95
+
96
+ attribute_map = {
97
+ 'description': 'description', # noqa: E501
98
+ 'esg_theme': 'esgTheme', # noqa: E501
99
+ 'search_concept': 'searchConcept', # noqa: E501
100
+ 'sentiment': 'sentiment', # noqa: E501
101
+ }
102
+
103
+ read_only_vars = {
104
+ }
105
+
106
+ _composed_schemas = {}
107
+
108
+ @classmethod
109
+ @convert_js_args_to_python_args
110
+ def _from_openapi_data(cls, description, *args, **kwargs): # noqa: E501
111
+ """Themes - a model defined in OpenAPI
112
+
113
+ Args:
114
+ description (str): theme description
115
+
116
+ Keyword Args:
117
+ _check_type (bool): if True, values for parameters in openapi_types
118
+ will be type checked and a TypeError will be
119
+ raised if the wrong type is input.
120
+ Defaults to True
121
+ _path_to_item (tuple/list): This is a list of keys or values to
122
+ drill down to the model in received_data
123
+ when deserializing a response
124
+ _spec_property_naming (bool): True if the variable names in the input data
125
+ are serialized names, as specified in the OpenAPI document.
126
+ False if the variable names in the input data
127
+ are pythonic names, e.g. snake case (default)
128
+ _configuration (Configuration): the instance to use when
129
+ deserializing a file_type parameter.
130
+ If passed, type conversion is attempted
131
+ If omitted no type conversion is done.
132
+ _visited_composed_classes (tuple): This stores a tuple of
133
+ classes that we have traveled through so that
134
+ if we see that class again we will not use its
135
+ discriminator again.
136
+ When traveling through a discriminator, the
137
+ composed schema that is
138
+ is traveled through is added to this set.
139
+ For example if Animal has a discriminator
140
+ petType and we pass in "Dog", and the class Dog
141
+ allOf includes Animal, we move through Animal
142
+ once using the discriminator, and pick Dog.
143
+ Then in Dog, we will make an instance of the
144
+ Animal class but this time we won't travel
145
+ through its discriminator because we passed in
146
+ _visited_composed_classes = (Animal,)
147
+ esg_theme (str): theme of the source.. [optional] # noqa: E501
148
+ search_concept (str): theme of the source.. [optional] # noqa: E501
149
+ sentiment (str): theme of the source.. [optional] # noqa: E501
150
+ """
151
+
152
+ _check_type = kwargs.pop('_check_type', True)
153
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
154
+ _path_to_item = kwargs.pop('_path_to_item', ())
155
+ _configuration = kwargs.pop('_configuration', None)
156
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
157
+
158
+ self = super(OpenApiModel, cls).__new__(cls)
159
+
160
+ if args:
161
+ raise ApiTypeError(
162
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
163
+ args,
164
+ self.__class__.__name__,
165
+ ),
166
+ path_to_item=_path_to_item,
167
+ valid_classes=(self.__class__,),
168
+ )
169
+
170
+ self._data_store = {}
171
+ self._check_type = _check_type
172
+ self._spec_property_naming = _spec_property_naming
173
+ self._path_to_item = _path_to_item
174
+ self._configuration = _configuration
175
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
176
+
177
+ self.description = description
178
+ for var_name, var_value in kwargs.items():
179
+ if var_name not in self.attribute_map and \
180
+ self._configuration is not None and \
181
+ self._configuration.discard_unknown_keys and \
182
+ self.additional_properties_type is None:
183
+ # discard variable.
184
+ continue
185
+ setattr(self, var_name, var_value)
186
+ return self
187
+
188
+ required_properties = set([
189
+ '_data_store',
190
+ '_check_type',
191
+ '_spec_property_naming',
192
+ '_path_to_item',
193
+ '_configuration',
194
+ '_visited_composed_classes',
195
+ ])
196
+
197
+ @convert_js_args_to_python_args
198
+ def __init__(self, description, *args, **kwargs): # noqa: E501
199
+ """Themes - a model defined in OpenAPI
200
+
201
+ Args:
202
+ description (str): theme description
203
+
204
+ Keyword Args:
205
+ _check_type (bool): if True, values for parameters in openapi_types
206
+ will be type checked and a TypeError will be
207
+ raised if the wrong type is input.
208
+ Defaults to True
209
+ _path_to_item (tuple/list): This is a list of keys or values to
210
+ drill down to the model in received_data
211
+ when deserializing a response
212
+ _spec_property_naming (bool): True if the variable names in the input data
213
+ are serialized names, as specified in the OpenAPI document.
214
+ False if the variable names in the input data
215
+ are pythonic names, e.g. snake case (default)
216
+ _configuration (Configuration): the instance to use when
217
+ deserializing a file_type parameter.
218
+ If passed, type conversion is attempted
219
+ If omitted no type conversion is done.
220
+ _visited_composed_classes (tuple): This stores a tuple of
221
+ classes that we have traveled through so that
222
+ if we see that class again we will not use its
223
+ discriminator again.
224
+ When traveling through a discriminator, the
225
+ composed schema that is
226
+ is traveled through is added to this set.
227
+ For example if Animal has a discriminator
228
+ petType and we pass in "Dog", and the class Dog
229
+ allOf includes Animal, we move through Animal
230
+ once using the discriminator, and pick Dog.
231
+ Then in Dog, we will make an instance of the
232
+ Animal class but this time we won't travel
233
+ through its discriminator because we passed in
234
+ _visited_composed_classes = (Animal,)
235
+ esg_theme (str): theme of the source.. [optional] # noqa: E501
236
+ search_concept (str): theme of the source.. [optional] # noqa: E501
237
+ sentiment (str): theme of the source.. [optional] # noqa: E501
238
+ """
239
+
240
+ _check_type = kwargs.pop('_check_type', True)
241
+ _spec_property_naming = kwargs.pop('_spec_property_naming', False)
242
+ _path_to_item = kwargs.pop('_path_to_item', ())
243
+ _configuration = kwargs.pop('_configuration', None)
244
+ _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
245
+
246
+ if args:
247
+ raise ApiTypeError(
248
+ "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
249
+ args,
250
+ self.__class__.__name__,
251
+ ),
252
+ path_to_item=_path_to_item,
253
+ valid_classes=(self.__class__,),
254
+ )
255
+
256
+ self._data_store = {}
257
+ self._check_type = _check_type
258
+ self._spec_property_naming = _spec_property_naming
259
+ self._path_to_item = _path_to_item
260
+ self._configuration = _configuration
261
+ self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
262
+
263
+ self.description = description
264
+ for var_name, var_value in kwargs.items():
265
+ if var_name not in self.attribute_map and \
266
+ self._configuration is not None and \
267
+ self._configuration.discard_unknown_keys and \
268
+ self.additional_properties_type is None:
269
+ # discard variable.
270
+ continue
271
+ setattr(self, var_name, var_value)
272
+ if var_name in self.read_only_vars:
273
+ raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
274
+ f"class with read only attributes.")