AnthropicAiModel
Inheritance: java.lang.Object, com.aspose.words.AiModel
All Implemented Interfaces: com.aspose.words.IAiModelText
public abstract class AnthropicAiModel extends AiModel implements IAiModelText
An abstract class representing the integration with Anthropic\u2019s AI models within the Aspose.Words.
Constructors
| Constructor | Description |
|---|---|
| AnthropicAiModel() |
Methods
| Method | Description |
|---|---|
| checkGrammar(Document sourceDocument, CheckGrammarOptions options) | Checks grammar of the provided document. |
| create(int modelType) | |
| summarize(Document sourceDocument) | |
| summarize(Document sourceDocument, SummarizeOptions options) | Generates a summary of the specified document, with options to adjust the length of the summary. |
| summarize(Document[] sourceDocuments) | |
| summarize(Document[] sourceDocuments, SummarizeOptions options) | Generates summaries for an array of documents, with options to control the summary length and other settings. |
| translate(Document sourceDocument, int targetLanguage) | |
| withApiKey(String apiKey) | Sets a specified API key to the model. |
AnthropicAiModel()
public AnthropicAiModel()
checkGrammar(Document sourceDocument, CheckGrammarOptions options)
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 | The document being checked for grammar. |
| options | CheckGrammarOptions | Optional settings to control how grammar will be checked. |
Returns: Document - A new Document with checked grammar.
create(int modelType)
public static AiModel create(int modelType)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| modelType | int |
Returns: AiModel
summarize(Document sourceDocument)
public Document summarize(Document sourceDocument)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sourceDocument | Document |
Returns: Document
summarize(Document sourceDocument, SummarizeOptions options)
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 | The document to be summarized. |
| options | SummarizeOptions | Optional settings to control the summary length and other parameters. |
Returns: Document - A summarized version of the document’s content.
summarize(Document[] sourceDocuments)
public Document summarize(Document[] sourceDocuments)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sourceDocuments | Document[] |
Returns: Document
summarize(Document[] sourceDocuments, SummarizeOptions options)
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[] | An array of documents to be summarized. |
| options | SummarizeOptions | Optional settings to control the summary length and other parameters |
Returns: Document - A summarized version of the document’s content.
translate(Document sourceDocument, int targetLanguage)
public Document translate(Document sourceDocument, int targetLanguage)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sourceDocument | Document | |
| targetLanguage | int |
Returns: Document
withApiKey(String apiKey)
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