fds.sdk.VectorData 0.0.3__tar.gz → 0.2.0__tar.gz
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.
- fds_sdk_vectordata-0.2.0/PKG-INFO +442 -0
- fds_sdk_vectordata-0.2.0/README.md +417 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/__init__.py +28 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/api/__init__.py +1 -1
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/api/intelligent_document_service_api.py +1362 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/api/vector_api.py +1469 -0
- fds_sdk_vectordata-0.0.3/fds/sdk/VectorData/api/meta_api.py → fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/api/vector_search_api.py +250 -139
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/api_client.py +7 -7
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/apis/__init__.py +3 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/configuration.py +4 -4
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/exceptions.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/base_result.py +302 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/chunk_text_response.py +2 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/chunk_text_response_meta.py +2 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/chunk_text_response_meta_pagination.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/chunk_text_result.py +356 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/document_types.py +2 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/document_types_response.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/documents_download.py +264 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/documents_status.py +284 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/edgar_search.py +276 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/edgar_search_result.py +387 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/edgar_search_result_all_of.py +296 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/edgar_vector.py +276 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/edgar_vector_result.py +391 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/edgar_vector_result_all_of.py +296 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/error_object.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/error_object_data.py +297 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/error_object_data_source.py +264 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/error_object_response.py +264 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/error_response.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/error_result.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/form_types.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/form_types_response.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_download_data.py +266 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_download_request.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_download_request_data.py +266 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_download_response.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_list_item.py +288 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_search_request.py +274 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_search_request_data.py +285 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_search_request_meta.py +274 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_search_response.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_search_response_meta.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_search_result.py +288 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_status_data.py +266 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_status_request.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_status_request_data.py +266 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_status_response.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_upload_data.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_upload_request.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_upload_request_data.py +275 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_document_upload_response.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/ids_documents_list_response.py +268 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/meta.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/news_search.py +285 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/news_search_result.py +367 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/news_search_result_all_of.py +270 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/news_vector.py +285 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/news_vector_result.py +371 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/news_vector_result_all_of.py +276 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/offset_pagination_request.py +267 -0
- fds_sdk_vectordata-0.0.3/fds/sdk/VectorData/model/chunk_text_result.py → fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/offset_pagination_response.py +13 -37
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/schemas.py +2 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/schemas_response.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_request.py +274 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_request_data.py +306 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_request_meta.py +274 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_request_meta_pagination.py +267 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_response.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_response_meta.py +262 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_response_meta_pagination.py +260 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/search_result.py +445 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/source.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/source_data.py +279 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/source_response.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/source_response_data.py +262 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/themes.py +4 -4
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/themes_response.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/transcript_search.py +276 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/transcript_search_result.py +415 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/transcript_search_result_all_of.py +318 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/transcript_vector.py +276 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/transcript_vector_result.py +419 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/transcript_vector_result_all_of.py +324 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/vector_data_request.py +2 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/vector_data_request_data.py +4 -4
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/vector_data_response.py +2 -2
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/vector_data_response_meta.py +4 -4
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/vector_data_result.py +8 -4
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/vector_response.py +268 -0
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/model/vector_result.py +449 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model_utils.py +2 -2
- fds_sdk_vectordata-0.2.0/fds/sdk/VectorData/models/__init__.py +92 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/rest.py +2 -2
- fds_sdk_vectordata-0.2.0/fds.sdk.VectorData.egg-info/PKG-INFO +442 -0
- fds_sdk_vectordata-0.2.0/fds.sdk.VectorData.egg-info/SOURCES.txt +105 -0
- fds_sdk_vectordata-0.2.0/fds.sdk.VectorData.egg-info/requires.txt +3 -0
- fds_sdk_vectordata-0.2.0/setup.py +47 -0
- fds_sdk_vectordata-0.0.3/PKG-INFO +0 -349
- fds_sdk_vectordata-0.0.3/README.md +0 -324
- fds_sdk_vectordata-0.0.3/fds/sdk/VectorData/__init__.py +0 -28
- fds_sdk_vectordata-0.0.3/fds/sdk/VectorData/api/vector_api.py +0 -564
- fds_sdk_vectordata-0.0.3/fds/sdk/VectorData/models/__init__.py +0 -31
- fds_sdk_vectordata-0.0.3/fds.sdk.VectorData.egg-info/PKG-INFO +0 -349
- fds_sdk_vectordata-0.0.3/fds.sdk.VectorData.egg-info/SOURCES.txt +0 -43
- fds_sdk_vectordata-0.0.3/fds.sdk.VectorData.egg-info/requires.txt +0 -3
- fds_sdk_vectordata-0.0.3/setup.py +0 -47
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/LICENSE +0 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/__init__.py +0 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/VectorData/model/__init__.py +0 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds/sdk/__init__.py +0 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds.sdk.VectorData.egg-info/dependency_links.txt +0 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/fds.sdk.VectorData.egg-info/top_level.txt +0 -0
- {fds_sdk_vectordata-0.0.3 → fds_sdk_vectordata-0.2.0}/setup.cfg +0 -0
|
@@ -0,0 +1,442 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fds.sdk.VectorData
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Vector Data client library for Python
|
|
5
|
+
Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0
|
|
6
|
+
Author: FactSet Research Systems
|
|
7
|
+
License: Apache License, Version 2.0
|
|
8
|
+
Keywords: FactSet,API,SDK
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Requires-Dist: urllib3>=2.7.0
|
|
13
|
+
Requires-Dist: python-dateutil>=2.9.0.post0
|
|
14
|
+
Requires-Dist: fds.sdk.utils>=1.0.0
|
|
15
|
+
Dynamic: author
|
|
16
|
+
Dynamic: description
|
|
17
|
+
Dynamic: description-content-type
|
|
18
|
+
Dynamic: home-page
|
|
19
|
+
Dynamic: keywords
|
|
20
|
+
Dynamic: license
|
|
21
|
+
Dynamic: license-file
|
|
22
|
+
Dynamic: requires-dist
|
|
23
|
+
Dynamic: requires-python
|
|
24
|
+
Dynamic: summary
|
|
25
|
+
|
|
26
|
+
[](https://www.factset.com)
|
|
27
|
+
|
|
28
|
+
# Vector Data client library for Python
|
|
29
|
+
|
|
30
|
+
[](https://developer.factset.com/api-catalog/vector-data-api)
|
|
31
|
+
[](https://pypi.org/project/fds.sdk.VectorData/v/0.2.0)
|
|
32
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
FactSet's Vector Data API helps asset managers, hedge funds, investment banks, and financial technology firms accelerate the development of next-generation AI and machine learning solutions by simplifying and optimizing access to unstructured financial documents.
|
|
36
|
+
|
|
37
|
+
This API provides streamlined access to vector data through its defined endpoints. It supports retrieving detailed vector data based on user-defined parameters. Efficiently processing associated text data for enhanced performance.
|
|
38
|
+
|
|
39
|
+
This API is designed to enable developers to integrate vector data into their applications, ensuring flexibility and performance while leveraging the specified endpoint functionalities.
|
|
40
|
+
|
|
41
|
+
> Access to the AI Ready version of FactSet collected documents with enrichments. Meant as an input to a client's RAG experience.
|
|
42
|
+
|
|
43
|
+
**Note:** Vector Data API performs semantic search across vectorized financial documents and returns results ranked by similarity score. Supports filtering by themes, sentiment, form types, date ranges, and entity identifiers.
|
|
44
|
+
|
|
45
|
+
`API Build & Advantages:`
|
|
46
|
+
|
|
47
|
+
**AI-Ready Unstructured Data Processing Pipeline:** Automate the ingestion, chunking, embedding, and indexing of high-value financial text-removing the need for manual pipeline development.
|
|
48
|
+
> **Out-of-the-box** support for FactSet proprietary and third-party datasets (StreetAccount News, CallStreet Transcripts, EDGAR Filings, MT Newswire and more to come).
|
|
49
|
+
|
|
50
|
+
> **Benchmark-driven** chunking strategies ensure optimal results for GenAI and RAG use.
|
|
51
|
+
|
|
52
|
+
**Platform & Embedding Model Agnostic:** Seamlessly integrate with any AI stack-works with cloud and on-prem environments and supports any embedding model you choose.
|
|
53
|
+
|
|
54
|
+
**Native Integration with Model Context Protocol (MCP):** Enable direct, standardized connectivity between your unstructured data workflows and MCP-compliant AI solutions, supporting context-aware generative AI, retrieval-augmented generation, and document-level search intelligence. Rich Metadata, Tagging, and Entity Resolution: Enhance AI models with entity and date resolution, topic tagging, sentiment labels, and links to FactSet's Unstructured Knowledge Graph, enabling richer, more accurate search and analysis.
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
60
|
+
|
|
61
|
+
- API version: 0.4.0
|
|
62
|
+
- SDK version: 0.2.0
|
|
63
|
+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
64
|
+
|
|
65
|
+
For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
|
|
66
|
+
|
|
67
|
+
## Requirements
|
|
68
|
+
|
|
69
|
+
* Python >= 3.7
|
|
70
|
+
|
|
71
|
+
## Installation
|
|
72
|
+
|
|
73
|
+
### Poetry
|
|
74
|
+
|
|
75
|
+
```shell
|
|
76
|
+
poetry add fds.sdk.utils fds.sdk.VectorData==0.2.0
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### pip
|
|
80
|
+
|
|
81
|
+
```shell
|
|
82
|
+
pip install fds.sdk.utils fds.sdk.VectorData==0.2.0
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Usage
|
|
86
|
+
|
|
87
|
+
1. [Generate authentication credentials](../../../../README.md#authentication).
|
|
88
|
+
2. Setup Python environment.
|
|
89
|
+
1. Install and activate python 3.10+. If you're using [pyenv](https://github.com/pyenv/pyenv):
|
|
90
|
+
|
|
91
|
+
```sh
|
|
92
|
+
pyenv install 3.10.0
|
|
93
|
+
pyenv shell 3.10.0
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
|
|
97
|
+
3. [Install dependencies](#installation).
|
|
98
|
+
4. Run the following:
|
|
99
|
+
|
|
100
|
+
> [!IMPORTANT]
|
|
101
|
+
> The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
|
|
102
|
+
|
|
103
|
+
### Example Code
|
|
104
|
+
|
|
105
|
+
```python
|
|
106
|
+
from fds.sdk.utils.authentication import ConfidentialClient
|
|
107
|
+
|
|
108
|
+
import fds.sdk.VectorData
|
|
109
|
+
from fds.sdk.VectorData.api import intelligent_document_service_api
|
|
110
|
+
from fds.sdk.VectorData.models import *
|
|
111
|
+
from dateutil.parser import parse as dateutil_parser
|
|
112
|
+
from pprint import pprint
|
|
113
|
+
|
|
114
|
+
# See configuration.py for a list of all supported configuration parameters.
|
|
115
|
+
|
|
116
|
+
# Examples for each supported authentication method are below,
|
|
117
|
+
# choose one that satisfies your use case.
|
|
118
|
+
|
|
119
|
+
# (Preferred) OAuth 2.0: FactSetOAuth2
|
|
120
|
+
# See https://github.com/FactSet/enterprise-sdk#oauth-20
|
|
121
|
+
# for information on how to create the app-config.json file
|
|
122
|
+
#
|
|
123
|
+
# The confidential client instance should be reused in production environments.
|
|
124
|
+
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
|
|
125
|
+
# for more information on using the ConfidentialClient class
|
|
126
|
+
configuration = fds.sdk.VectorData.Configuration(
|
|
127
|
+
fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
|
|
128
|
+
)
|
|
129
|
+
|
|
130
|
+
# Basic authentication: FactSetApiKey
|
|
131
|
+
# See https://github.com/FactSet/enterprise-sdk#api-key
|
|
132
|
+
# for information how to create an API key
|
|
133
|
+
# configuration = fds.sdk.VectorData.Configuration(
|
|
134
|
+
# username='USERNAME-SERIAL',
|
|
135
|
+
# password='API-KEY'
|
|
136
|
+
# )
|
|
137
|
+
|
|
138
|
+
# Enter a context with an instance of the API client
|
|
139
|
+
with fds.sdk.VectorData.ApiClient(configuration) as api_client:
|
|
140
|
+
# Create an instance of the API class
|
|
141
|
+
api_instance = intelligent_document_service_api.IntelligentDocumentServiceApi(api_client)
|
|
142
|
+
ids_document_upload_request = IdsDocumentUploadRequest(
|
|
143
|
+
data=IdsDocumentUploadRequestData(
|
|
144
|
+
file_name="annual-report-2024.pdf",
|
|
145
|
+
file_type="Pdf",
|
|
146
|
+
),
|
|
147
|
+
) # IdsDocumentUploadRequest | Document registration request.
|
|
148
|
+
|
|
149
|
+
try:
|
|
150
|
+
# Register a document and receive a presigned upload URL
|
|
151
|
+
# example passing only required values which don't have defaults set
|
|
152
|
+
api_response = api_instance.create_ids_document_upload(ids_document_upload_request)
|
|
153
|
+
|
|
154
|
+
pprint(api_response)
|
|
155
|
+
except fds.sdk.VectorData.ApiException as e:
|
|
156
|
+
print("Exception when calling IntelligentDocumentServiceApi->create_ids_document_upload: %s\n" % e)
|
|
157
|
+
|
|
158
|
+
# # Get response, http status code and response headers
|
|
159
|
+
# try:
|
|
160
|
+
# # Register a document and receive a presigned upload URL
|
|
161
|
+
# api_response, http_status_code, response_headers = api_instance.create_ids_document_upload_with_http_info(ids_document_upload_request)
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
# pprint(api_response)
|
|
165
|
+
# pprint(http_status_code)
|
|
166
|
+
# pprint(response_headers)
|
|
167
|
+
# except fds.sdk.VectorData.ApiException as e:
|
|
168
|
+
# print("Exception when calling IntelligentDocumentServiceApi->create_ids_document_upload: %s\n" % e)
|
|
169
|
+
|
|
170
|
+
# # Get response asynchronous
|
|
171
|
+
# try:
|
|
172
|
+
# # Register a document and receive a presigned upload URL
|
|
173
|
+
# async_result = api_instance.create_ids_document_upload_async(ids_document_upload_request)
|
|
174
|
+
# api_response = async_result.get()
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
# pprint(api_response)
|
|
178
|
+
# except fds.sdk.VectorData.ApiException as e:
|
|
179
|
+
# print("Exception when calling IntelligentDocumentServiceApi->create_ids_document_upload: %s\n" % e)
|
|
180
|
+
|
|
181
|
+
# # Get response, http status code and response headers asynchronous
|
|
182
|
+
# try:
|
|
183
|
+
# # Register a document and receive a presigned upload URL
|
|
184
|
+
# async_result = api_instance.create_ids_document_upload_with_http_info_async(ids_document_upload_request)
|
|
185
|
+
# api_response, http_status_code, response_headers = async_result.get()
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
# pprint(api_response)
|
|
189
|
+
# pprint(http_status_code)
|
|
190
|
+
# pprint(response_headers)
|
|
191
|
+
# except fds.sdk.VectorData.ApiException as e:
|
|
192
|
+
# print("Exception when calling IntelligentDocumentServiceApi->create_ids_document_upload: %s\n" % e)
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Using Pandas
|
|
197
|
+
|
|
198
|
+
To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
|
|
199
|
+
```python
|
|
200
|
+
import pandas as pd
|
|
201
|
+
|
|
202
|
+
response_dict = api_response.to_dict()['data']
|
|
203
|
+
|
|
204
|
+
simple_json_response = pd.DataFrame(response_dict)
|
|
205
|
+
nested_json_response = pd.json_normalize(response_dict)
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Debugging
|
|
209
|
+
|
|
210
|
+
The SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.
|
|
211
|
+
|
|
212
|
+
Setting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`
|
|
213
|
+
and enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).
|
|
214
|
+
|
|
215
|
+
**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.
|
|
216
|
+
|
|
217
|
+
```python
|
|
218
|
+
import logging
|
|
219
|
+
import fds.sdk.VectorData
|
|
220
|
+
|
|
221
|
+
logging.basicConfig(level=logging.DEBUG)
|
|
222
|
+
|
|
223
|
+
configuration = fds.sdk.VectorData.Configuration(...)
|
|
224
|
+
configuration.debug = True
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Configure a Proxy
|
|
228
|
+
|
|
229
|
+
You can pass proxy settings to the Configuration class:
|
|
230
|
+
|
|
231
|
+
* `proxy`: The URL of the proxy to use.
|
|
232
|
+
* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).
|
|
233
|
+
|
|
234
|
+
```python
|
|
235
|
+
import fds.sdk.VectorData
|
|
236
|
+
|
|
237
|
+
configuration = fds.sdk.VectorData.Configuration(
|
|
238
|
+
# ...
|
|
239
|
+
proxy="http://secret:password@localhost:5050",
|
|
240
|
+
proxy_headers={
|
|
241
|
+
"Custom-Proxy-Header": "Custom-Proxy-Header-Value"
|
|
242
|
+
}
|
|
243
|
+
)
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Custom SSL Certificate
|
|
247
|
+
|
|
248
|
+
TLS/SSL certificate verification can be configured with the following Configuration parameters:
|
|
249
|
+
|
|
250
|
+
* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.
|
|
251
|
+
* `verify_ssl`: setting this to `False` disables the verification of certificates.
|
|
252
|
+
Disabling the verification is not recommended, but it might be useful during
|
|
253
|
+
local development or testing.
|
|
254
|
+
|
|
255
|
+
```python
|
|
256
|
+
import fds.sdk.VectorData
|
|
257
|
+
|
|
258
|
+
configuration = fds.sdk.VectorData.Configuration(
|
|
259
|
+
# ...
|
|
260
|
+
ssl_ca_cert='/path/to/ca.pem'
|
|
261
|
+
)
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Request Retries
|
|
265
|
+
|
|
266
|
+
In case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.
|
|
267
|
+
|
|
268
|
+
```python
|
|
269
|
+
from urllib3 import Retry
|
|
270
|
+
import fds.sdk.VectorData
|
|
271
|
+
|
|
272
|
+
configuration = fds.sdk.VectorData.Configuration(
|
|
273
|
+
# ...
|
|
274
|
+
)
|
|
275
|
+
|
|
276
|
+
configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
## Documentation for API Endpoints
|
|
281
|
+
|
|
282
|
+
All URIs are relative to *https://api.factset.com/content/vector/v0*
|
|
283
|
+
|
|
284
|
+
Class | Method | HTTP request | Description
|
|
285
|
+
------------ | ------------- | ------------- | -------------
|
|
286
|
+
*IntelligentDocumentServiceApi* | [**create_ids_document_upload**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IntelligentDocumentServiceApi.md#create_ids_document_upload) | **POST** /documents/register | Register a document and receive a presigned upload URL
|
|
287
|
+
*IntelligentDocumentServiceApi* | [**get_ids_document_download**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IntelligentDocumentServiceApi.md#get_ids_document_download) | **POST** /documents/download | Get a presigned URL to download processed document output.
|
|
288
|
+
*IntelligentDocumentServiceApi* | [**get_ids_document_status**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IntelligentDocumentServiceApi.md#get_ids_document_status) | **POST** /documents/status | Retrieve ingestion status for one or more documents.
|
|
289
|
+
*IntelligentDocumentServiceApi* | [**list_all_ids_documents**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IntelligentDocumentServiceApi.md#list_all_ids_documents) | **GET** /documents/list | List all uploaded documents
|
|
290
|
+
*IntelligentDocumentServiceApi* | [**search_ids_documents**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IntelligentDocumentServiceApi.md#search_ids_documents) | **POST** /documents/search | Semantically search uploaded documents
|
|
291
|
+
*VectorApi* | [**get_count**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorApi.md#get_count) | **GET** /chunk-text | Returns chunked text for the given vectorId.
|
|
292
|
+
*VectorApi* | [**get_document_types**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorApi.md#get_document_types) | **GET** /meta/document-types | Returns the document types.
|
|
293
|
+
*VectorApi* | [**get_sources**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorApi.md#get_sources) | **GET** /meta/sources | Returns the sources.
|
|
294
|
+
*VectorApi* | [**get_themes**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorApi.md#get_themes) | **GET** /meta/themes | Returns the themes.
|
|
295
|
+
*VectorApi* | [**getschemas**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorApi.md#getschemas) | **GET** /meta/schemas | Returns the schemas.
|
|
296
|
+
*VectorApi* | [**post_vector**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorApi.md#post_vector) | **POST** /data | Return vector information based on the input parameters below
|
|
297
|
+
*VectorSearchApi* | [**get_form_types**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorSearchApi.md#get_form_types) | **GET** /form-types | Returns the available form types
|
|
298
|
+
*VectorSearchApi* | [**get_vector**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorSearchApi.md#get_vector) | **GET** /vector | Returns vector data and metadata for specified vector IDs
|
|
299
|
+
*VectorSearchApi* | [**post_search**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorSearchApi.md#post_search) | **POST** /search | Perform semantic search and return ranked results with similarity scores
|
|
300
|
+
*VectorSearchApi* | [**retrieve_sources**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorSearchApi.md#retrieve_sources) | **GET** /sources | Returns the available data sources
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
## Documentation For Models
|
|
304
|
+
|
|
305
|
+
- [BaseResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/BaseResult.md)
|
|
306
|
+
- [ChunkTextResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ChunkTextResponse.md)
|
|
307
|
+
- [ChunkTextResponseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ChunkTextResponseMeta.md)
|
|
308
|
+
- [ChunkTextResponseMetaPagination](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ChunkTextResponseMetaPagination.md)
|
|
309
|
+
- [ChunkTextResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ChunkTextResult.md)
|
|
310
|
+
- [DocumentTypes](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/DocumentTypes.md)
|
|
311
|
+
- [DocumentTypesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/DocumentTypesResponse.md)
|
|
312
|
+
- [DocumentsDownload](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/DocumentsDownload.md)
|
|
313
|
+
- [DocumentsStatus](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/DocumentsStatus.md)
|
|
314
|
+
- [EDGARSearch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/EDGARSearch.md)
|
|
315
|
+
- [EDGARSearchResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/EDGARSearchResult.md)
|
|
316
|
+
- [EDGARSearchResultAllOf](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/EDGARSearchResultAllOf.md)
|
|
317
|
+
- [EDGARVector](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/EDGARVector.md)
|
|
318
|
+
- [EDGARVectorResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/EDGARVectorResult.md)
|
|
319
|
+
- [EDGARVectorResultAllOf](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/EDGARVectorResultAllOf.md)
|
|
320
|
+
- [ErrorObject](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ErrorObject.md)
|
|
321
|
+
- [ErrorObjectData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ErrorObjectData.md)
|
|
322
|
+
- [ErrorObjectDataSource](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ErrorObjectDataSource.md)
|
|
323
|
+
- [ErrorObjectResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ErrorObjectResponse.md)
|
|
324
|
+
- [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ErrorResponse.md)
|
|
325
|
+
- [ErrorResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ErrorResult.md)
|
|
326
|
+
- [FormTypes](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/FormTypes.md)
|
|
327
|
+
- [FormTypesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/FormTypesResponse.md)
|
|
328
|
+
- [IdsDocumentDownloadData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentDownloadData.md)
|
|
329
|
+
- [IdsDocumentDownloadRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentDownloadRequest.md)
|
|
330
|
+
- [IdsDocumentDownloadRequestData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentDownloadRequestData.md)
|
|
331
|
+
- [IdsDocumentDownloadResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentDownloadResponse.md)
|
|
332
|
+
- [IdsDocumentListItem](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentListItem.md)
|
|
333
|
+
- [IdsDocumentSearchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentSearchRequest.md)
|
|
334
|
+
- [IdsDocumentSearchRequestData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentSearchRequestData.md)
|
|
335
|
+
- [IdsDocumentSearchRequestMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentSearchRequestMeta.md)
|
|
336
|
+
- [IdsDocumentSearchResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentSearchResponse.md)
|
|
337
|
+
- [IdsDocumentSearchResponseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentSearchResponseMeta.md)
|
|
338
|
+
- [IdsDocumentSearchResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentSearchResult.md)
|
|
339
|
+
- [IdsDocumentStatusData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentStatusData.md)
|
|
340
|
+
- [IdsDocumentStatusRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentStatusRequest.md)
|
|
341
|
+
- [IdsDocumentStatusRequestData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentStatusRequestData.md)
|
|
342
|
+
- [IdsDocumentStatusResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentStatusResponse.md)
|
|
343
|
+
- [IdsDocumentUploadData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentUploadData.md)
|
|
344
|
+
- [IdsDocumentUploadRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentUploadRequest.md)
|
|
345
|
+
- [IdsDocumentUploadRequestData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentUploadRequestData.md)
|
|
346
|
+
- [IdsDocumentUploadResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentUploadResponse.md)
|
|
347
|
+
- [IdsDocumentsListResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/IdsDocumentsListResponse.md)
|
|
348
|
+
- [Meta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/Meta.md)
|
|
349
|
+
- [NewsSearch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/NewsSearch.md)
|
|
350
|
+
- [NewsSearchResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/NewsSearchResult.md)
|
|
351
|
+
- [NewsSearchResultAllOf](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/NewsSearchResultAllOf.md)
|
|
352
|
+
- [NewsVector](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/NewsVector.md)
|
|
353
|
+
- [NewsVectorResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/NewsVectorResult.md)
|
|
354
|
+
- [NewsVectorResultAllOf](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/NewsVectorResultAllOf.md)
|
|
355
|
+
- [OffsetPaginationRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/OffsetPaginationRequest.md)
|
|
356
|
+
- [OffsetPaginationResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/OffsetPaginationResponse.md)
|
|
357
|
+
- [Schemas](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/Schemas.md)
|
|
358
|
+
- [SchemasResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SchemasResponse.md)
|
|
359
|
+
- [SearchRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchRequest.md)
|
|
360
|
+
- [SearchRequestData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchRequestData.md)
|
|
361
|
+
- [SearchRequestMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchRequestMeta.md)
|
|
362
|
+
- [SearchRequestMetaPagination](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchRequestMetaPagination.md)
|
|
363
|
+
- [SearchResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchResponse.md)
|
|
364
|
+
- [SearchResponseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchResponseMeta.md)
|
|
365
|
+
- [SearchResponseMetaPagination](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchResponseMetaPagination.md)
|
|
366
|
+
- [SearchResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SearchResult.md)
|
|
367
|
+
- [Source](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/Source.md)
|
|
368
|
+
- [SourceData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SourceData.md)
|
|
369
|
+
- [SourceResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SourceResponse.md)
|
|
370
|
+
- [SourceResponseData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/SourceResponseData.md)
|
|
371
|
+
- [Themes](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/Themes.md)
|
|
372
|
+
- [ThemesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/ThemesResponse.md)
|
|
373
|
+
- [TranscriptSearch](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/TranscriptSearch.md)
|
|
374
|
+
- [TranscriptSearchResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/TranscriptSearchResult.md)
|
|
375
|
+
- [TranscriptSearchResultAllOf](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/TranscriptSearchResultAllOf.md)
|
|
376
|
+
- [TranscriptVector](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/TranscriptVector.md)
|
|
377
|
+
- [TranscriptVectorResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/TranscriptVectorResult.md)
|
|
378
|
+
- [TranscriptVectorResultAllOf](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/TranscriptVectorResultAllOf.md)
|
|
379
|
+
- [VectorDataRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorDataRequest.md)
|
|
380
|
+
- [VectorDataRequestData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorDataRequestData.md)
|
|
381
|
+
- [VectorDataResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorDataResponse.md)
|
|
382
|
+
- [VectorDataResponseMeta](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorDataResponseMeta.md)
|
|
383
|
+
- [VectorDataResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorDataResult.md)
|
|
384
|
+
- [VectorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorResponse.md)
|
|
385
|
+
- [VectorResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/VectorData/v0/docs/VectorResult.md)
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
## Documentation For Authorization
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
## FactSetApiKey
|
|
392
|
+
|
|
393
|
+
- **Type**: HTTP basic authentication
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
## FactSetOAuth2
|
|
397
|
+
|
|
398
|
+
- **Type**: OAuth
|
|
399
|
+
- **Flow**: application
|
|
400
|
+
- **Authorization URL**:
|
|
401
|
+
- **Scopes**: N/A
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
## Notes for Large OpenAPI documents
|
|
405
|
+
If the OpenAPI document is large, imports in fds.sdk.VectorData.apis and fds.sdk.VectorData.models may fail with a
|
|
406
|
+
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
|
|
407
|
+
|
|
408
|
+
Solution 1:
|
|
409
|
+
Use specific imports for apis and models like:
|
|
410
|
+
- `from fds.sdk.VectorData.api.default_api import DefaultApi`
|
|
411
|
+
- `from fds.sdk.VectorData.model.pet import Pet`
|
|
412
|
+
|
|
413
|
+
Solution 2:
|
|
414
|
+
Before importing the package, adjust the maximum recursion limit as shown below:
|
|
415
|
+
```
|
|
416
|
+
import sys
|
|
417
|
+
sys.setrecursionlimit(1500)
|
|
418
|
+
import fds.sdk.VectorData
|
|
419
|
+
from fds.sdk.VectorData.apis import *
|
|
420
|
+
from fds.sdk.VectorData.models import *
|
|
421
|
+
```
|
|
422
|
+
|
|
423
|
+
## Contributing
|
|
424
|
+
|
|
425
|
+
Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
|
|
426
|
+
|
|
427
|
+
## Copyright
|
|
428
|
+
|
|
429
|
+
Copyright 2026 FactSet Research Systems Inc
|
|
430
|
+
|
|
431
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
432
|
+
you may not use this file except in compliance with the License.
|
|
433
|
+
You may obtain a copy of the License at
|
|
434
|
+
|
|
435
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
436
|
+
|
|
437
|
+
Unless required by applicable law or agreed to in writing, software
|
|
438
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
439
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
440
|
+
See the License for the specific language governing permissions and
|
|
441
|
+
limitations under the License.
|
|
442
|
+
|