AiModel class

AiModel class

Represents information about a Generative Language Model.

Methods

NameDescription
as_google_ai_model()Cast AiModel to GoogleAiModel.
as_open_ai_model()Cast AiModel to OpenAiModel.
create(model_type)Creates a new instance of AiModel class.
with_api_key(api_key)Sets a specified API key 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

AiModelType enumeration