Summarize
Contents
[
Hide
]Summarize(Document, SummarizeOptions)
Generates a summary of the specified document, with options to adjust the length of the summary. This operation leverages the connected AI model for content processing.
public Document Summarize(Document sourceDocument, SummarizeOptions options = null)
| Parameter | Type | Description |
|---|---|---|
| sourceDocument | Document | The document to be summarized. |
| options | SummarizeOptions | Optional settings to control the summary length and other parameters. |
Return Value
A summarized version of the document’s content.
Examples
Shows how to summarize text using OpenAI and Google models.
Document firstDoc = new Document(MyDir + "Big document.docx");
Document secondDoc = new Document(MyDir + "Document.docx");
string apiKey = Environment.GetEnvironmentVariable("API_KEY");
// Use OpenAI or Google generative language models.
IAiModelText model = ((OpenAiModel)AiModel.Create(AiModelType.Gpt4OMini).WithApiKey(apiKey)).WithOrganization("Organization").WithProject("Project");
SummarizeOptions options = new SummarizeOptions();
options.SummaryLength = SummaryLength.Short;
Document oneDocumentSummary = model.Summarize(firstDoc, options);
oneDocumentSummary.Save(ArtifactsDir + "AI.AiSummarize.One.docx");
options.SummaryLength = SummaryLength.Long;
Document multiDocumentSummary = model.Summarize(new Document[] { firstDoc, secondDoc }, options);
multiDocumentSummary.Save(ArtifactsDir + "AI.AiSummarize.Multi.docx");
See Also
- class Document
- class SummarizeOptions
- interface IAiModelText
- namespace Aspose.Words.AI
- assembly Aspose.Words
Summarize(Document[], SummarizeOptions)
Generates summaries for an array of documents, with options to control the summary length and other settings. This method utilizes the connected AI model for processing each document in the array.
public Document Summarize(Document[] sourceDocuments, SummarizeOptions options = null)
| Parameter | Type | Description |
|---|---|---|
| sourceDocuments | Document[] | An array of documents to be summarized. |
| options | SummarizeOptions | Optional settings to control the summary length and other parameters |
Return Value
A summarized version of the document’s content.
Examples
Shows how to summarize text using OpenAI and Google models.
Document firstDoc = new Document(MyDir + "Big document.docx");
Document secondDoc = new Document(MyDir + "Document.docx");
string apiKey = Environment.GetEnvironmentVariable("API_KEY");
// Use OpenAI or Google generative language models.
IAiModelText model = ((OpenAiModel)AiModel.Create(AiModelType.Gpt4OMini).WithApiKey(apiKey)).WithOrganization("Organization").WithProject("Project");
SummarizeOptions options = new SummarizeOptions();
options.SummaryLength = SummaryLength.Short;
Document oneDocumentSummary = model.Summarize(firstDoc, options);
oneDocumentSummary.Save(ArtifactsDir + "AI.AiSummarize.One.docx");
options.SummaryLength = SummaryLength.Long;
Document multiDocumentSummary = model.Summarize(new Document[] { firstDoc, secondDoc }, options);
multiDocumentSummary.Save(ArtifactsDir + "AI.AiSummarize.Multi.docx");
See Also
- class Document
- class SummarizeOptions
- interface IAiModelText
- namespace Aspose.Words.AI
- assembly Aspose.Words