com.aspose.words

Class AiModel

java.lang.Object

com.aspose.words.AiModel

Direct Known Subclasses:

AnthropicAiModel, GoogleAiModel, OpenAiModel

public abstract class AiModel
extends java.lang.Object

An abstract class representing the integration with various AI models within the Aspose.Words.

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");
 
 

Constructor Summary

Constructors

Constructor and Description
AiModel()

Method Summary

Modifier and Type	Method and Description
Document	checkGrammar(Document sourceDocument, CheckGrammarOptions options) Checks grammar of the provided document.
static AiModel	create(int modelType)
protected abstract java.lang.String	getName()
protected abstract java.lang.String	getUrl()
abstract Document	summarize(Document[] sourceDocuments, SummarizeOptions options) Generates summaries for an array of documents, with options to control the summary length and other settings.
abstract Document	summarize(Document sourceDocument, SummarizeOptions options) Generates a summary of the specified document, with options to adjust the length of the summary.
abstract Document	translate(Document sourceDocument, int targetLanguage)
AiModel	withApiKey(java.lang.String apiKey) Sets a specified API key to the model.

Methods inherited from class java.lang.Object

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

Constructor Detail

AiModel

public AiModel()

Method Detail

summarize

public abstract Document summarize(Document sourceDocument,
                                   SummarizeOptions options)
                            throws java.lang.Exception

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.

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");
 
 

Parameters:

sourceDocument - The document to be summarized.

options - Optional settings to control the summary length and other parameters.

Returns:

A summarized version of the document's content.

Throws:

java.lang.Exception

summarize

public abstract Document summarize(Document[] sourceDocuments,
                                   SummarizeOptions options)
                            throws java.lang.Exception

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.

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");
 
 

Parameters:

sourceDocuments - An array of documents to be summarized.

options - Optional settings to control the summary length and other parameters

Returns:

A summarized version of the document's content.

Throws:

java.lang.Exception

checkGrammar

public Document checkGrammar(Document sourceDocument,
                             CheckGrammarOptions options)
                      throws java.lang.Exception

Checks grammar of the provided document. This operation leverages the connected AI model for checking grammar of document.

Examples:

Shows how to check the grammar of a document.

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

 String apiKey = System.getenv("API_KEY");
 // Use OpenAI generative language models.
 AiModel model = AiModel.create(AiModelType.GPT_4_O_MINI).withApiKey(apiKey);

 CheckGrammarOptions grammarOptions = new CheckGrammarOptions();
 grammarOptions.setImproveStylistics(true);

 Document proofedDoc = model.checkGrammar(doc, grammarOptions);
 proofedDoc.save(getArtifactsDir() + "AI.AiGrammar.docx");
 
 

Parameters:

sourceDocument - The document being checked for grammar.

options - Optional settings to control how grammar will be checked.

Returns:

A new Document with checked grammar.

Throws:

java.lang.Exception

translate

public abstract Document translate(Document sourceDocument,
                                   int targetLanguage)
                            throws java.lang.Exception

Throws:

java.lang.Exception

withApiKey

public AiModel withApiKey(java.lang.String apiKey)

Sets a specified API key to the model.

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");
 
 

create

public static AiModel create(int modelType)

getName

protected abstract java.lang.String getName()

getUrl

protected abstract java.lang.String getUrl()