com.aspose.words

Class CheckGrammarOptions

java.lang.Object

com.aspose.words.CheckGrammarOptions

public class CheckGrammarOptions
extends java.lang.Object

Allows to specify various options while checking grammar of a document using AI.

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

Method Summary

Modifier and Type	Method and Description
boolean	getImproveStylistics() Allows to specify either AI will try to improve stylistics of the text being proofed.
boolean	getMakeRevisions() Allows to specify either final or revised document to be returned with proofed text.
boolean	getPreserveFormatting() Allows to specify either IAiModelText.checkGrammar(com.aspose.words.Document, com.aspose.words.CheckGrammarOptions) will try to preserve layout and formatting of the original document, or not.
void	setImproveStylistics(boolean value) Allows to specify either AI will try to improve stylistics of the text being proofed.
void	setMakeRevisions(boolean value) Allows to specify either final or revised document to be returned with proofed text.
void	setPreserveFormatting(boolean value) Allows to specify either IAiModelText.checkGrammar(com.aspose.words.Document, com.aspose.words.CheckGrammarOptions) will try to preserve layout and formatting of the original document, or not.

Methods inherited from class java.lang.Object

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

Method Detail

getMakeRevisions

public boolean getMakeRevisions()

Allows to specify either final or revised document to be returned with proofed text. Default value is false.

Returns:

The corresponding boolean value.

setMakeRevisions

public void setMakeRevisions(boolean value)

Allows to specify either final or revised document to be returned with proofed text. Default value is false.

Parameters:

value - The corresponding boolean value.

getImproveStylistics

public boolean getImproveStylistics()

Allows to specify either AI will try to improve stylistics of the text being proofed. Default value is false.

Returns:

The corresponding boolean value.

setImproveStylistics

public void setImproveStylistics(boolean value)

Allows to specify either AI will try to improve stylistics of the text being proofed. Default value is false.

Parameters:

value - The corresponding boolean value.

getPreserveFormatting

public boolean getPreserveFormatting()

Allows to specify either IAiModelText.checkGrammar(com.aspose.words.Document, com.aspose.words.CheckGrammarOptions) will try to preserve layout and formatting of the original document, or not. Default value is true.

Remarks:

When the option is set to false, the quality of grammar checking is higher than when this option is set to true. However, the original formatting of the text is not preserved in this case.

Returns:

The corresponding boolean value.

setPreserveFormatting

public void setPreserveFormatting(boolean value)

Allows to specify either IAiModelText.checkGrammar(com.aspose.words.Document, com.aspose.words.CheckGrammarOptions) will try to preserve layout and formatting of the original document, or not. Default value is true.

Remarks:

When the option is set to false, the quality of grammar checking is higher than when this option is set to true. However, the original formatting of the text is not preserved in this case.

Parameters:

value - The corresponding boolean value.