FactSet.SDK.Conversational 0.0.1

Conversational client library for .NET

This API lets you send a question to FactSet's conversational agent and get an answer back, formatted the same way OpenAI's Chat Completions API formats its responses. That means tools already built to talk to OpenAI-style chat APIs (chat UIs, IDE assistants, evaluation harnesses, and so on) can talk to conversational agent with little or no changes.

A few things work a bit differently from a typical OpenAI integration:

• Even though you can send a full list of messages (a "chat history"), only the most recent message from the user is actually used as the question being asked. Any earlier messages, or a system prompt, are ignored.
• Instead, the API keeps track of the conversation for you. Each conversation has an id (conversation_id). Send that id back on your next request and the assistant will remember what was said before and continue the same conversation. Leave it out and a new conversation is started, with a fresh id handed back to you to reuse next time.
• The answer isn't returned all at once — it's streamed back a little at a time as it's generated, using a format called Server-Sent Events (text/event-stream). This is the same streaming format OpenAI's API uses, so most existing client libraries already know how to read it. The stream always ends with a data: [DONE] line so the client knows there's nothing more coming.

A note on FactSet's internal API standards: this endpoint's contract is intentionally OpenAI's Chat Completions API contract, not FactSet's own API design standards — that's the entire point of the endpoint, since it lets existing OpenAI-compatible clients work against it unmodified. Where the two disagree, OpenAI's contract wins by design, and the FactSet standard does not apply. In particular:

• Member names (finish_reason, reasoning_content, factset_configuration, conversation_id, return_raw_link_context, factset_context) are snake_case, matching OpenAI's own field naming (and, for reasoning_content, DeepSeek's), rather than FactSet's camelCase convention.
• Error responses are plain text, matching this service's shared error-handling framework, rather than FactSet's structured {\"errors\": [...]} JSON envelope.

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 0.2.0
• SDK version: 0.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.Conversational -v 0.0.1

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.Conversational -Version 0.0.1

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. Run the following:

Example Code

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

namespace Example
{
    public static class ChatCompletionExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.Conversational.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 chatCompletionRequest = new ChatCompletionRequest(); // ChatCompletionRequest | 
            var consumer = "developer-portal";  // string | A short name identifying which application or integration is making this call, used for FactSet's own usage tracking. If omitted, usage is tracked under a generic default value rather than the request being rejected. (optional) 

            try
            {
                // Ask a question and stream back the answer (OpenAI-compatible)
                ChatCompletionChunk result = apiInstance.ChatCompletion(chatCompletionRequest, consumer);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling ChatApi.ChatCompletion: " + 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/v0

Documentation for Models

• Model.ChatCompletionChunk
• Model.ChatCompletionRequest
• Model.ChatMessage
• Model.FactSetConfiguration
• Model.Model
• Model.ModelList
• Model.ResponseChoices
• Model.ResponseChoicesDelta

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.