com.aspose.words

Class SummaryLength

java.lang.Object

com.aspose.words.SummaryLength

public class SummaryLength
extends java.lang.Object

Enumerates possible lengths of summary.

Examples:

Shows how to summarize text using OpenAI and Google models.

 
 Document firstDoc = new Document(getMyDir() + "Big document.docx");
 Document secondDoc = new Document(getMyDir() + "Document.docx");

 String apiKey = System.getenv("API_KEY");
 // Use OpenAI or Google generative language models.
 AiModel model = ((OpenAiModel)AiModel.create(AiModelType.GPT_4_O_MINI).withApiKey(apiKey)).withOrganization("Organization").withProject("Project");

 SummarizeOptions options = new SummarizeOptions();

 options.setSummaryLength(SummaryLength.SHORT);
 Document oneDocumentSummary = model.summarize(firstDoc, options);
 oneDocumentSummary.save(getArtifactsDir() + "AI.AiSummarize.One.docx");

 options.setSummaryLength(SummaryLength.LONG);
 Document multiDocumentSummary = model.summarize(new Document[] { firstDoc, secondDoc }, options);
 multiDocumentSummary.save(getArtifactsDir() + "AI.AiSummarize.Multi.docx");
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	length
static int	LONG Try to generate 7-10 sentences.
static int	MEDIUM Try to generate 5-6 sentences.
static int	SHORT Try to generate 3-4 sentences.
static int	VERY_LONG Try to generate 11-20 sentences.
static int	VERY_SHORT Try to generate 1-2 sentences.

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String summaryLengthName)
static java.lang.String	getName(int summaryLength)
static int[]	getValues()
static java.lang.String	toString(int summaryLength)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERY_SHORT

public static int VERY_SHORT

Try to generate 1-2 sentences.

SHORT

public static int SHORT

Try to generate 3-4 sentences.

MEDIUM

public static int MEDIUM

Try to generate 5-6 sentences.

LONG

public static int LONG

Try to generate 7-10 sentences.

VERY_LONG

public static int VERY_LONG

Try to generate 11-20 sentences.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int summaryLength)

toString

public static java.lang.String toString(int summaryLength)

fromName

public static int fromName(java.lang.String summaryLengthName)

getValues

public static int[] getValues()