OpenAiModel

Inheritance: java.lang.Object, com.aspose.words.AiModel

All Implemented Interfaces: com.aspose.words.IAiModelText

public abstract class OpenAiModel extends AiModel implements IAiModelText

An abstract class representing the integration with OpenAI’s large language models within the Aspose.Words.

Examples:

Shows how to use self-hosted AI model based on OpenAiModel.

 public void selfHostedModel() throws Exception
 {
     Document doc = new Document(getMyDir() + "Big document.docx");

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

     Document translatedDoc = model.translate(doc, Language.RUSSIAN);
     translatedDoc.save(getArtifactsDir() + "AI.SelfHostedModel.docx");
 }

 /// 
 /// Custom self-hosted AI model.
 /// 
 static class CustomAiModel extends OpenAiModel
 {
     /// 
     /// Gets custom URL of the model.
     /// 
     protected "; }

     /// 
     /// Gets model name.
     /// 
     protected  String getName() { return "my-model-24b"; }
 

}

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

## Methods

| Method | Description |
| --- | --- |
| [checkGrammar(Document sourceDocument, CheckGrammarOptions options)](#checkGrammar-com.aspose.words.Document-com.aspose.words.CheckGrammarOptions) | Checks grammar of the provided document. |
| [create(int modelType)](#create-int) |  |
| [summarize(Document sourceDocument)](#summarize-com.aspose.words.Document) |  |
| [summarize(Document sourceDocument, SummarizeOptions options)](#summarize-com.aspose.words.Document-com.aspose.words.SummarizeOptions) | Generates a summary of the specified document, with options to adjust the length of the summary. |
| [summarize(Document[] sourceDocuments)](#summarize-com.aspose.words.Document) |  |
| [summarize(Document[] sourceDocuments, SummarizeOptions options)](#summarize-com.aspose.words.Document---com.aspose.words.SummarizeOptions) | Generates summaries for an array of documents, with options to control the summary length and other settings. |
| [translate(Document sourceDocument, int targetLanguage)](#translate-com.aspose.words.Document-int) |  |
| [withApiKey(String apiKey)](#withApiKey-java.lang.String) | Sets a specified API key to the model. |
| [withOrganization(String organizationId)](#withOrganization-java.lang.String) | Sets a specified Organization to the model. |
| [withProject(String projectId)](#withProject-java.lang.String) | Sets a specified Project to the model. |
### checkGrammar(Document sourceDocument, CheckGrammarOptions options) {#checkGrammar-com.aspose.words.Document-com.aspose.words.CheckGrammarOptions}

public Document checkGrammar(Document sourceDocument, CheckGrammarOptions options)

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:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocument | [Document](../../com.aspose.words/document/) | The document being checked for grammar. |
| options | [CheckGrammarOptions](../../com.aspose.words/checkgrammaroptions/) | Optional settings to control how grammar will be checked. |

**Returns:**
[Document](../../com.aspose.words/document/) - A new [Document](../../com.aspose.words/document/) with checked grammar.
### create(int modelType) {#create-int}

public static AiModel create(int modelType)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| modelType | int |  |

**Returns:**
[AiModel](../../com.aspose.words/aimodel/)
### summarize(Document sourceDocument) {#summarize-com.aspose.words.Document}

public Document summarize(Document sourceDocument)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocument | [Document](../../com.aspose.words/document/) |  |

**Returns:**
[Document](../../com.aspose.words/document/)
### summarize(Document sourceDocument, SummarizeOptions options) {#summarize-com.aspose.words.Document-com.aspose.words.SummarizeOptions}

public Document summarize(Document sourceDocument, SummarizeOptions 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.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocument | [Document](../../com.aspose.words/document/) | The document to be summarized. |
| options | [SummarizeOptions](../../com.aspose.words/summarizeoptions/) | Optional settings to control the summary length and other parameters. |

**Returns:**
[Document](../../com.aspose.words/document/) - A summarized version of the document's content.
### summarize(Document[] sourceDocuments) {#summarize-com.aspose.words.Document}

public Document summarize(Document[] sourceDocuments)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocuments | [Document\[\]](../../com.aspose.words/document/) |  |

**Returns:**
[Document](../../com.aspose.words/document/)
### summarize(Document[] sourceDocuments, SummarizeOptions options) {#summarize-com.aspose.words.Document---com.aspose.words.SummarizeOptions}

public Document summarize(Document[] sourceDocuments, SummarizeOptions 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.

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocuments | [Document\[\]](../../com.aspose.words/document/) | An array of documents to be summarized. |
| options | [SummarizeOptions](../../com.aspose.words/summarizeoptions/) | Optional settings to control the summary length and other parameters |

**Returns:**
[Document](../../com.aspose.words/document/) - A summarized version of the document's content.
### translate(Document sourceDocument, int targetLanguage) {#translate-com.aspose.words.Document-int}

public Document translate(Document sourceDocument, int targetLanguage)

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDocument | [Document](../../com.aspose.words/document/) |  |
| targetLanguage | int |  |

**Returns:**
[Document](../../com.aspose.words/document/)
### withApiKey(String apiKey) {#withApiKey-java.lang.String}

public AiModel withApiKey(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”);

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| apiKey | java.lang.String |  |

**Returns:**
[AiModel](../../com.aspose.words/aimodel/)
### withOrganization(String organizationId) {#withOrganization-java.lang.String}

public OpenAiModel withOrganization(String organizationId)

Sets a specified Organization 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”);

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| organizationId | java.lang.String |  |

**Returns:**
[OpenAiModel](../../com.aspose.words/openaimodel/)
### withProject(String projectId) {#withProject-java.lang.String}

public OpenAiModel withProject(String projectId)

Sets a specified Project 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”);

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| projectId | java.lang.String |  |

**Returns:**
[OpenAiModel](../../com.aspose.words/openaimodel/)