Foundry.LlmModel¶

Subclasses:: None

Methods¶

Inherited:: Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)
Structs:: GObject.ObjectClass (5)

	`chat` (system)
	`complete` (roles, messages)
	`dup_digest` ()
	`dup_name` ()
	`is_metered` ()

Virtual Methods¶

Inherited:: GObject.Object (7), Json.Serializable (5)

	`do_chat` (system)
	`do_complete` (roles, messages)
	`do_dup_digest` ()
	`do_dup_name` ()
	`do_is_metered` ()

Properties¶

Inherited:: Foundry.Contextual (1)

Name	Type	Flags
`digest`	`str`	r
`metered`	`bool`	r
`name`	`str`	r

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Foundry.Contextual`	r

Class Details¶

class Foundry.LlmModel(**kwargs)¶

Bases:: Foundry.Contextual
Abstract:: Yes
Structure:: Foundry.LlmModelClass

chat(system)¶

Parameters:: system (str or None) – the system prompt for the chat
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.LlmConversation] or rejects with error.
Return type:: Dex.Future

Start a new conversation with the model.

complete(roles, messages)¶

Parameters:

roles (str) – the roles for each message
messages (str) – the message content

Returns:

a [class`Dex`.Future] that resolves to a [class`Foundry`.LlmCompletion].

Return type:

Dex.Future

Requests completion using roles and messages.

Each element of roles corresponds to the element at the same index of messages.

The length of messages and roles must be the same.

dup_digest()¶

Return type:: str

dup_name()¶

Return type:: str

is_metered()¶

Returns:: True if the model may be metered.
Return type:: bool

Gets the “metered” property.

do_chat(system) virtual¶

Parameters:: system (str or None) – the system prompt for the chat
Returns:: a [class`Dex`.Future] that resolves to a [class`Foundry`.LlmConversation] or rejects with error.
Return type:: Dex.Future

Start a new conversation with the model.

do_complete(roles, messages) virtual¶

Parameters:

roles (str) – the roles for each message
messages (str) – the message content

Returns:

a [class`Dex`.Future] that resolves to a [class`Foundry`.LlmCompletion].

Return type:

Dex.Future

Requests completion using roles and messages.

Each element of roles corresponds to the element at the same index of messages.

The length of messages and roles must be the same.

do_dup_digest() virtual¶

Return type:: str

do_dup_name() virtual¶

Return type:: str

do_is_metered() virtual¶

Returns:: True if the model may be metered.
Return type:: bool

Gets the “metered” property.

Property Details¶

Foundry.LlmModel.props.digest¶

Name:: digest
Type:: str
Default Value:: None
Flags:: READABLE

Foundry.LlmModel.props.metered¶

Name:: metered
Type:: bool
Default Value:: False
Flags:: READABLE

Foundry.LlmModel.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE