FactSet.SDK.AITextSummarization
0.21.2
Prefix Reserved
See the version list below for details.
dotnet add package FactSet.SDK.AITextSummarization --version 0.21.2
NuGet\Install-Package FactSet.SDK.AITextSummarization -Version 0.21.2
<PackageReference Include="FactSet.SDK.AITextSummarization" Version="0.21.2" />
paket add FactSet.SDK.AITextSummarization --version 0.21.2
#r "nuget: FactSet.SDK.AITextSummarization, 0.21.2"
// Install FactSet.SDK.AITextSummarization as a Cake Addin #addin nuget:?package=FactSet.SDK.AITextSummarization&version=0.21.2 // Install FactSet.SDK.AITextSummarization as a Cake Tool #tool nuget:?package=FactSet.SDK.AITextSummarization&version=0.21.2
AI Text Summarization client library for .NET
AI Text Summarization
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 0.21.2
- Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen
Requirements
- .NET Standard >= 2.0
Installation
.NET CLI
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.AITextSummarization
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.AITextSummarization
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.AITextSummarization.Api;
using FactSet.SDK.AITextSummarization.Client;
using FactSet.SDK.AITextSummarization.Model;
namespace Example
{
public static class GetResultV1ResultResultIdExample
{
public static async Task Main()
{
var config = new FactSet.SDK.AITextSummarization.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
// 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 DefaultApi(config);
var resultId = "resultId_example"; // string |
try
{
// GET request that returns the full headline and summary results from the initial POST requests
SuccessResponse result = apiInstance.GetResultV1ResultResultId(resultId);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling DefaultApi.GetResultV1ResultResultId: " + 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 http://api.factset.com/cognitive/summarization/v1
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | GetResultV1ResultResultId | GET /result/{result_id} | GET request that returns the full headline and summary results from the initial POST requests |
DefaultApi | PostHeadlineAndSummaryV1HeadlineAndSummary | POST /headline-and-summary | POST request to create a 2-3 sentence summary from input text |
DefaultApi | PostHeadlineV1Headline | POST /headline | POST request to create a headline from input text |
DefaultApi | PostSummaryV1Summary | POST /summary | POST request to create a headline and summary from input text |
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.
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. |
.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.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.2)
- 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.
Version | Downloads | Last updated |
---|---|---|
0.21.10 | 59 | 7/11/2024 |
0.21.9 | 100 | 4/10/2024 |
0.21.8 | 246 | 10/25/2023 |
0.21.7 | 121 | 8/30/2023 |
0.21.6 | 130 | 8/11/2023 |
0.21.5 | 118 | 6/6/2023 |
0.21.4 | 117 | 5/11/2023 |
0.21.3 | 208 | 3/1/2023 |
0.21.2 | 212 | 2/24/2023 |
0.21.1 | 354 | 8/31/2022 |
0.21.0 | 353 | 7/21/2022 |
0.20.1 | 383 | 6/1/2022 |
0.20.0 | 381 | 5/24/2022 |
Refer to Changelog on GitHub source repository