npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@factset/sdk-conversationalapipoweredbyfactsetmercury

v1.0.1

Published

Conversational API Powered by FactSet Mercury client library for JavaScript

Downloads

190

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

enterprisesdkenterprisesdkfdsfdstsouthmaydfdstsouthmaydfds

Keywords

FactSetAPISDK

Readme

FactSet

Conversational API Powered by FactSet Mercury client library for JavaScript

API Version npm Apache-2 license

OVERVIEW

The FactSet Conversational API allows clients to white-label core FactSet Mercury capabilities in a client's chatbot experience.

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.
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 FatSet Support.

FAQ

How can I receive updates on changes to the Conversational API? - Please 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. Why am I receiving a 403 error with a valid API key? - Please ensure that your current public IP is within the IP range allocated to the API key you are using to authenticate API requests. You can update your API key's allowable IP range via the FactSet Developer Portal API Authentication page. If this does not resolve the issue, please reach out to FactSet Support to ensure you are appropriately authorized to access the Conversational API.

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

  • API version: 1.0.3
  • SDK version: 1.0.1
  • 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/[email protected]

yarn

yarn add @factset/sdk-utils @factset/[email protected]

Usage

  1. Generate authentication credentials.
  2. 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.

  3. Install dependencies.
  4. 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 chatPollingRequest = {"data":{"jobId":"9c1031c2-5463-47ae-81b3-126a68f0c2a6"}}; // ChatPollingRequest | Polling request body, containing the job ID for your response generation process

// Call api endpoint
apiInstance.getChatResult(chatPollingRequest).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:[email protected]: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

Copyright 2022 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.