Class OpenAISummaryCopilot

Classe OpenAISummaryCopilot

Fournit des fonctionnalités pour obtenir des résumés de documents en utilisant des modèles d’IA. Exemple d’utilisation de la création d’un client OpenAI, de la configuration des options et de l’utilisation du copilote de résumé.

// Create AI client.
var openAiClient = OpenAIClient
    .CreateWithApiKey(ApiKey) // Create OpenAI client with the API key.
    .WithProject("proj_RoywW1DLqDC89GoAW5ngoVN8") // Configure optional parameters.
    .Build();

// Create copilot options.
var options = OpenAISummaryCopilotOptions
    .Create() // Create options like this, or...
    //.Create(options => { options.Model = OpenAIModels.Gpt35Turbo; }) // ...create using delegate.
    .WithTemperature(0.5) // Configure other optional parameters.
    .WithDocument("DocumentInputPath") // .WithDocument methods allows to add text, pdf and paths to documents.
    .WithDocuments(new List<TextDocument>()); // .WithDocuments methods allows to add text, pdf and path collections.

// Create summary copilot.
var summaryCopilot = AICopilotFactory.CreateSummaryCopilot(openAiClient, options);

// Get summary text.
string summaryText = await summaryCopilot.GetSummaryAsync();

// Get summary document.
Document summaryDocument = await summaryCopilot.GetSummaryDocumentAsync();

// Get summary document with page info.
Document summaryDocumentWithPageInfo = await summaryCopilot.GetSummaryDocumentAsync(new PageInfo());

// Save summary as PDF document.
await summaryCopilot.SaveSummaryAsync("outputPath");

// Save summary with specified format.
await summaryCopilot.SaveSummaryAsync("outputPath", SaveFormat.DocX);
public class OpenAISummaryCopilot : ISummaryCopilot

Constructeurs

NomDescription
OpenAISummaryCopilot(IOpenAIClient, ISummaryCopilotOptions<OpenAISummaryCopilotOptions>)Initialise une nouvelle instance de la classe OpenAISummaryCopilot.

Propriétés

NomDescription
HasContext { get; }

Méthodes

NomDescription
GetSummaryAsync(CancellationToken?)
GetSummaryDocumentAsync(CancellationToken?)
GetSummaryDocumentAsync(PageInfo, CancellationToken?)
SaveSummaryAsync(string, CancellationToken?)
SaveSummaryAsync(string, SaveFormat, CancellationToken?)

Voir aussi