SummaryLength enumeration

SummaryLength enumeration

Enumerates possible lengths of summary.

Members

NameDescription
VeryShortTry to generate 1-2 sentences.
ShortTry to generate 3-4 sentences.
MediumTry to generate 5-6 sentences.
LongTry to generate 7-10 sentences.
VeryLongTry to generate 11-20 sentences.

Examples

Shows how to summarize text using OpenAI and Google models.

let firstDoc = new aw.Document(base.myDir + "Big document.docx");
let secondDoc = new aw.Document(base.myDir + "Document.docx");

const apiKey = process.env.API_KEY;
if (!apiKey) {
  console.warn("API_KEY environment variable is not set.");
  return;
}

// Use OpenAI or Google generative language models.
let model = aw.AI.AiModel.createGpt4OMini();
model.setApiKey(apiKey);
model.setOrganization("Organization");
model.setProject("Project");

let options = new aw.AI.SummarizeOptions();

options.summaryLength = aw.AI.SummaryLength.Short;
let oneDocumentSummary = model.summarize(firstDoc, options);
oneDocumentSummary.save(base.artifactsDir + "AI.AiSummarize.one.docx");

options.summaryLength = aw.AI.SummaryLength.Long;
let multiDocumentSummary = model.summarize([firstDoc, secondDoc], options);
multiDocumentSummary.save(base.artifactsDir + "AI.AiSummarize.multi.docx");

See Also

SummarizeOptions class