OpenAiModel class
OpenAiModel class
An abstract class representing the integration with OpenAI’s large language models within the Aspose.Words.
Inheritance: OpenAiModel → AiModel
Interfaces: IAiModelText
Methods
| Name | Description |
|---|---|
| create(model_type) | Creates a new instance of AiModel class. (Inherited from AiModel) |
| summarize(source_document, 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. (Inherited from IAiModelText) |
| summarize(source_documents, 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. (Inherited from IAiModelText) |
| translate(source_document, target_language) | Translates the provided document into the specified target language. This operation leverages the connected AI model for content translating. (Inherited from IAiModelText) |
| with_api_key(api_key) | Sets a specified API key to the model. (Inherited from AiModel) |
| with_organization(organization_id) | Sets a specified Organization to the model. |
| with_project(project_id) | Sets a specified Project to the model. |
Examples
Shows how to summarize text using OpenAI and Google models.
first_doc = aw.Document(file_name=MY_DIR + "Big document.docx")
second_doc = aw.Document(file_name=MY_DIR + "Document.docx")
api_key = system_helper.environment.Environment.get_environment_variable("API_KEY")
# Use OpenAI or Google generative language models.
model = aw.ai.AiModel.create(aw.ai.AiModelType.GPT_4O_MINI).with_api_key(api_key).as_open_ai_model()
options = aw.ai.SummarizeOptions()
options.summary_length = aw.ai.SummaryLength.SHORT
one_document_summary = model.summarize(source_document=first_doc, options=options)
one_document_summary.save(file_name=ARTIFACTS_DIR + "AI.AiSummarize.One.docx")
options.summary_length = aw.ai.SummaryLength.LONG
multi_document_summary = model.summarize(source_documents=[first_doc, second_doc], options=options)
multi_document_summary.save(file_name=ARTIFACTS_DIR + "AI.AiSummarize.Multi.docx")
See Also
- module aspose.words.ai
- class AiModel
- class IAiModelText