summarize method

summarize(doc, options)

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.

def summarize(self, doc: aspose.words.Document, options: aspose.words.ai.SummarizeOptions):
    ...
ParameterTypeDescription
docDocumentThe document to be summarized.
optionsSummarizeOptionsOptional settings to control the summary length and other parameters.

Returns

A summarized version of the document’s content.

summarize(docs, options)

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.

def summarize(self, docs: List[aspose.words.Document], options: aspose.words.ai.SummarizeOptions):
    ...
ParameterTypeDescription
docsList[Document]An array of documents to be summarized.
optionsSummarizeOptionsOptional settings to control the summary length and other parameters

Returns

A summarized version of the document’s content.

Examples

Shows how to summarize text using OpenAI and Google models.

first_doc = aw.Document(MyDir + "Big document.docx")
second_doc = aw.Document(MyDir + "Document.docx")
api_key = os.getenv("API_KEY")
# Use OpenAI or Google generative language models.
model = aw.ai.AiModel.create(aw.ai.AiModelType.GPT_4O_MINI).with_api_key(api_key).as_open_ai_model()
options = aw.ai.SummarizeOptions()
options.summary_length = aw.ai.SummaryLength.SHORT
one_document_summary = model.summarize(first_doc, options)
oneDocumentSummary.save(ArtifactsDir + "AI.AiSummarize.One.docx")
options.summary_length = aw.ai.SummaryLength.LONG
multi_document_summary = model.summarize([first_doc, second_doc], options)
multiDocumentSummary.save(ArtifactsDir + "AI.AiSummarize.Multi.docx")

See Also