Class LlamaSummaryCopilot

LlamaSummaryCopilot class

提供使用 AI 模型获取文档摘要的功能。创建 Llama 客户端、配置选项和使用摘要助手的示例用法。注意:此助手使用完成 API,因此可以发送的文本总量受到模型上下文窗口的限制。

// Create AI client.
var llamaClient = LlamaClient
   .CreateWithApiKey(ApiKey) // Create Llama client with the API key.
   .Build();

// Create copilot options.
var options = LlamaSummaryCopilotOptions
   .Create() // Create options like this, or...
   //.Create(options => { options.Model = LlamaModels.Llama13BChat; }) // ...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(llamaClient, 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 LlamaSummaryCopilot : ISummaryCopilot

Constructors

NameDescription
LlamaSummaryCopilot(ILlamaClient, ISummaryCopilotOptions<LlamaSummaryCopilotOptions>)初始化 LlamaSummaryCopilot 类的新实例。

Properties

NameDescription
HasContext { get; }

Methods

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

See Also