FactSet.SDK.ConversationalAPIPoweredbyFactSetMercury 1.0.1

Conversational API Powered by FactSet Mercury client library for .NET

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 .NET 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.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.ConversationalAPIPoweredbyFactSetMercury -v 1.0.1

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.ConversationalAPIPoweredbyFactSetMercury -Version 1.0.1

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
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

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.ConversationalAPIPoweredbyFactSetMercury.Api;
using FactSet.SDK.ConversationalAPIPoweredbyFactSetMercury.Client;
using FactSet.SDK.ConversationalAPIPoweredbyFactSetMercury.Model;

namespace Example
{
    public static class GetChatResultExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.ConversationalAPIPoweredbyFactSetMercury.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 ChatApi(config);
            var chatPollingRequest = new ChatPollingRequest(); // ChatPollingRequest | Polling request body, containing the job ID for your response generation process

            try
            {
                // Retrieve the completed response for your query
                QueryResponse result = apiInstance.GetChatResult(chatPollingRequest);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling ChatApi.GetChatResult: " + 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/conversational/v1

Documentation for Models

• Model.AdaptiveCard
• Model.BadFeedbackRequestError
• Model.BadFeedbackRequestErrorObject
• Model.BadRequestError
• Model.BadRequestErrorObject
• Model.BadRequestErrorWithInvalidDataSchema
• Model.BadRequestErrorWithInvalidDataSchemaObject
• Model.ChatPollingRequest
• Model.ChatPollingRequestData
• Model.Download
• Model.FederationData
• Model.FeedbackRequest
• Model.FeedbackRequestData
• Model.FileDownloadRequest
• Model.FileDownloadRequestData
• Model.FileGenerationErrorObject
• Model.ForbiddenError
• Model.ForbiddenErrorObject
• Model.InternalServerError
• Model.InternalServerErrorObject
• Model.NextStep
• Model.NextStepItem
• Model.OpenUrl
• Model.OpenUrlUrl
• Model.Phrase
• Model.PromptItem
• Model.PromptParameter
• Model.PromptParameters
• Model.QueryChatRequest
• Model.QueryChatRequestData
• Model.QueryChatResponse
• Model.QueryChatResponseData
• Model.QueryResponse
• Model.QueryResponseData
• Model.ResourceNotFoundError
• Model.ResourceNotFoundErrorObject
• Model.ResponseText
• Model.SpeakerInfo
• Model.StatusPollResponse
• Model.StatusPollResponseData
• Model.SuggestedPrompts
• Model.Table

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.