FactSet.SDK.VectorData
0.1.0
Prefix Reserved
dotnet add package FactSet.SDK.VectorData --version 0.1.0
NuGet\Install-Package FactSet.SDK.VectorData -Version 0.1.0
<PackageReference Include="FactSet.SDK.VectorData" Version="0.1.0" />
<PackageVersion Include="FactSet.SDK.VectorData" Version="0.1.0" />
<PackageReference Include="FactSet.SDK.VectorData" />
paket add FactSet.SDK.VectorData --version 0.1.0
#r "nuget: FactSet.SDK.VectorData, 0.1.0"
#:package FactSet.SDK.VectorData@0.1.0
#addin nuget:?package=FactSet.SDK.VectorData&version=0.1.0
#tool nuget:?package=FactSet.SDK.VectorData&version=0.1.0
Vector Data client library for .NET
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.
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.
This API is designed to enable developers to integrate vector data into their applications, ensuring flexibility and performance while leveraging the specified endpoint functionalities.
Access to the AI Ready version of FactSet collected documents with enrichments. Meant as an input to a client's RAG experience.
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.
API Build & Advantages:
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.
Out-of-the-box support for FactSet proprietary and third-party datasets (StreetAccount News, CallStreet Transcripts, EDGAR Filings, MT Newswire and more to come).
Benchmark-driven chunking strategies ensure optimal results for GenAI and RAG use.
Platform & Embedding Model Agnostic: Seamlessly integrate with any AI stack-works with cloud and on-prem environments and supports any embedding model you choose.
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.
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 0.4.0
- SDK version: 0.1.0
- Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen
For more information, please visit https://developer.factset.com/contact
Requirements
- .NET Standard >= 2.0
Installation
.NET CLI
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.VectorData -v 0.1.0
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.VectorData -Version 0.1.0
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.VectorData.Api;
using FactSet.SDK.VectorData.Client;
using FactSet.SDK.VectorData.Model;
namespace Example
{
public static class CreateIdsDocumentUploadExample
{
public static async Task Main()
{
var config = new FactSet.SDK.VectorData.Client.Configuration();
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
/* (Preferred) OAuth 2.0: FactSetOAuth2 */
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
//
// The confidential client instance should be reused in production environments.
// See https://github.com/FactSet/enterprise-sdk-utils-dotnet#authentication
// for more information on using the ConfidentialClient class
ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
config.OAuth2Client = confidentialClient;
/* Basic authentication: FactSetApiKey */
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// config.Username = "USERNAME-SERIAL";
// config.Password = "API-KEY";
var apiInstance = new IntelligentDocumentServiceApi(config);
var idsDocumentUploadRequest = new IdsDocumentUploadRequest(); // IdsDocumentUploadRequest | Document registration request.
try
{
// Register a document and receive a presigned upload URL
IdsDocumentUploadResponse result = apiInstance.CreateIdsDocumentUpload(idsDocumentUploadRequest);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling IntelligentDocumentServiceApi.CreateIdsDocumentUpload: " + e.Message );
Console.WriteLine("Status Code: "+ e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
}
Using a Proxy
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content/vector/v0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| IntelligentDocumentServiceApi | CreateIdsDocumentUpload | POST /documents/register | Register a document and receive a presigned upload URL |
| IntelligentDocumentServiceApi | GetIdsDocumentDownload | POST /documents/download | Get a presigned URL to download processed document output. |
| IntelligentDocumentServiceApi | GetIdsDocumentStatus | POST /documents/status | Retrieve ingestion status for one or more documents. |
| IntelligentDocumentServiceApi | ListAllIdsDocuments | GET /documents/list | List all uploaded documents |
| IntelligentDocumentServiceApi | SearchIdsDocuments | POST /documents/search | Semantically search uploaded documents |
| VectorApi | GetCount | GET /chunk-text | Returns chunked text for the given vectorId. |
| VectorApi | GetDocumentTypes | GET /meta/document-types | Returns the document types. |
| VectorApi | GetSources | GET /meta/sources | Returns the sources. |
| VectorApi | GetThemes | GET /meta/themes | Returns the themes. |
| VectorApi | Getschemas | GET /meta/schemas | Returns the schemas. |
| VectorApi | PostVector | POST /data | Return vector information based on the input parameters below |
| VectorSearchApi | GetFormTypes | GET /form-types | Returns the available form types |
| VectorSearchApi | GetVector | GET /vector | Returns vector data and metadata for specified vector IDs |
| VectorSearchApi | PostSearch | POST /search | Perform semantic search and return ranked results with similarity scores |
| VectorSearchApi | RetrieveSources | GET /sources | Returns the available data sources |
Documentation for Models
- Model.BaseResult
- Model.ChunkTextResponse
- Model.ChunkTextResponseMeta
- Model.ChunkTextResponseMetaPagination
- Model.ChunkTextResult
- Model.DocumentTypes
- Model.DocumentTypesResponse
- Model.DocumentsDownload
- Model.DocumentsStatus
- Model.EDGARSearch
- Model.EDGARSearchResult
- Model.EDGARSearchResultAllOf
- Model.EDGARVector
- Model.EDGARVectorResult
- Model.EDGARVectorResultAllOf
- Model.ErrorObject
- Model.ErrorObjectData
- Model.ErrorObjectDataSource
- Model.ErrorObjectResponse
- Model.ErrorResponse
- Model.ErrorResult
- Model.FormTypes
- Model.FormTypesResponse
- Model.IdsDocumentDownloadData
- Model.IdsDocumentDownloadRequest
- Model.IdsDocumentDownloadRequestData
- Model.IdsDocumentDownloadResponse
- Model.IdsDocumentListItem
- Model.IdsDocumentSearchRequest
- Model.IdsDocumentSearchRequestData
- Model.IdsDocumentSearchRequestMeta
- Model.IdsDocumentSearchResponse
- Model.IdsDocumentSearchResponseMeta
- Model.IdsDocumentSearchResult
- Model.IdsDocumentStatusData
- Model.IdsDocumentStatusRequest
- Model.IdsDocumentStatusRequestData
- Model.IdsDocumentStatusResponse
- Model.IdsDocumentUploadData
- Model.IdsDocumentUploadRequest
- Model.IdsDocumentUploadRequestData
- Model.IdsDocumentUploadResponse
- Model.IdsDocumentsListResponse
- Model.Meta
- Model.NewsSearch
- Model.NewsSearchResult
- Model.NewsSearchResultAllOf
- Model.NewsVector
- Model.NewsVectorResult
- Model.NewsVectorResultAllOf
- Model.OffsetPaginationRequest
- Model.OffsetPaginationResponse
- Model.Schemas
- Model.SchemasResponse
- Model.SearchRequest
- Model.SearchRequestData
- Model.SearchRequestMeta
- Model.SearchRequestMetaPagination
- Model.SearchResponse
- Model.SearchResponseMeta
- Model.SearchResponseMetaPagination
- Model.SearchResult
- Model.Source
- Model.SourceData
- Model.SourceResponse
- Model.SourceResponseData
- Model.Themes
- Model.ThemesResponse
- Model.TranscriptSearch
- Model.TranscriptSearchResult
- Model.TranscriptSearchResultAllOf
- Model.TranscriptVector
- Model.TranscriptVectorResult
- Model.TranscriptVectorResultAllOf
- Model.VectorDataRequest
- Model.VectorDataRequestData
- Model.VectorDataResponse
- Model.VectorDataResponseMeta
- Model.VectorDataResult
- Model.VectorResponse
- Model.VectorResult
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2026 FactSet Research Systems Inc
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.1.0)
- JsonSubTypes (>= 1.9.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly (>= 7.2.4)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Refer to Changelog on GitHub source repository