@factset/sdk-conversationalapipoweredbyfactsetmerc

Conversational API Powered by FactSet Mercury client library for JavaScript

OVERVIEW

The FactSet Conversational API allows clients to integrate core FactSet Mercury capabilities in chatbot experiences.

The Conversational API is powered by FactSet Mercury, FactSet's Generative Artificial Intelligence (GenAI) large language model. The Conversational API provides a variety of content and capabilities, including FactSet’s Federation layer (FactSet’s core GenAI-based technology), as well as more specific content and functionality tailored for financial services workflows.

The Conversational API provides answers to hundreds of natural language search queries and allows you to easily ask questions related to companies and markets research.

Some example supported prompts:

Nintendo's highest closing stock price over the last 3 months
Has Yelp issued any guidance?
What are the key trends impacting costs for DaVita?

For Information on Access to and Content Available via the Conversational API

Please see the Conversational API Online Assistant Page. Here you can find instructions on how to set up access to the Conversational API, and the full list of content available.

Conversational API Consumer Workflow

The Conversational API is an asynchronous API that utilizes status polling to inform the consumer when a query response is complete. Please see the technical OpenAPI documentation below for specific information regarding consuming the API programmatically.

At a high level, the API consumer workflow is as follows:

1) Send a natural language query to the /query endpoint and start the response generation process. 2) Poll the status of the response generation process using the /status endpoint. 3) Once the status indicates a ready response, retrieve it using the /result endpoint.

If your response contains a file ID, such as for an Excel chart or a FactSet ActiveGraph, retrieve it using the file ID at the /download/file endpoint.
To provide feedback on your response and help the Conversational API better serve you content, we encourage you to use the /feedback endpoint.

Receive updates on changes to the Conversational API

Subscribe to our FactSet Notify by clicking \"Subscribe to notifications\" in the upper right above the API overview. You will receive email updates when any updates occur to the API

FAQ & Troubleshooting

Please find FAQs and troubleshooting tips in the FAQs section of the Conversational API OA page

Current Limitations

\"Natural language\" in this documentation refers to modern conversational English. Support for other languages is currently unavailable.
The Conversational API is currently limited to accept 10 natural language queries per minute and 200 per hour for an individual consumer. If you anticipate your needs to be greater than these limits, please reach out to FactSet Support.

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

API version: 1.1.1
SDK version: 1.2.0
Build package: com.factset.sdk.codegen.FactSetJavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

Node.js >= 18

Installation

npm

npm install @factset/sdk-utils @factset/sdk-conversationalapipoweredbyfactsetmercury@1.2.0

yarn

yarn add @factset/sdk-utils @factset/sdk-conversationalapipoweredbyfactsetmercury@1.2.0

Usage

Generate authentication credentials.
Setup Node.js environment
1. Install and activate Node.js >=18. If you're using nvm:
```
nvm install 18
nvm use 18
```
2. (optional) Install yarn.
Install dependencies.
Run the following:

!IMPORTANT The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

const { ApiClient, ChatApi } = require('@factset/sdk-conversationalapipoweredbyfactsetmercury');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// 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-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new ConfidentialClient('/path/to/app-config.json');

// Basic authentication: FactSetApiKey
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new ChatApi();
const queryChatRequest = new conversationalapipoweredbyfactsetmercury.QueryChatRequest(); // QueryChatRequest | Request body to the `/query` endpoint, containing the natural language query to be sent to FactSet Mercury and an optional chat ID for continuing an ongoing conversation.

// Call api endpoint
apiInstance.sendQuery(queryChatRequest).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Using a Proxy

To add a HTTP proxy for the API client, you can set the proxyUrl for the ApiClient instance:

const { ApiClient } = require('@factset/sdk-conversationalapipoweredbyfactsetmercury');

const apiClient = ApiClient.instance;
apiClient.setProxyUrl('http://username:password@proxy.example.com:8080');

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/conversational/v1

Class	Method	HTTP request	Description
conversationalapipoweredbyfactsetmercury.ChatApi	getChatResult	POST /result	Retrieve the completed response for your query
conversationalapipoweredbyfactsetmercury.ChatApi	getChatStatus	POST /status	Retrieve the status of a chat response generation process
conversationalapipoweredbyfactsetmercury.ChatApi	sendQuery	POST /query	Send a natural language query to FactSet Mercury
conversationalapipoweredbyfactsetmercury.DownloadApi	downloadFile	POST /download/file	Retrieve data file based on file ID.
conversationalapipoweredbyfactsetmercury.FeedbackApi	sendFeedback	POST /feedback	Send feedback on the response to a query.

Documentation for Models

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

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.

FactSet API SDK

@factset/sdk-utils proxy-agent superagent

5 months ago

8 months ago

11 months ago

8 months ago

11 months ago