Class swarmauri_standard.llms.LlamaCppModel.LlamaCppModel
swarmauri_standard.llms.LlamaCppModel.LlamaCppModel
LlamaCppModel(**data)
Bases: LLMBase
A class for interacting with LlamaCpp's model API for text generation.
This implementation uses httpx for both synchronous and asynchronous HTTP requests, providing support for predictions, streaming responses, and batch processing.
ATTRIBUTE | DESCRIPTION |
---|---|
api_key |
API key for authentication (optional for local LlamaCpp)
TYPE:
|
allowed_models |
List of supported model identifiers
TYPE:
|
name |
The currently selected model name
TYPE:
|
type |
Type identifier for the model class
TYPE:
|
timeout |
Request timeout in seconds
TYPE:
|
Initializes the LlamaCppModel instance and sets up httpx clients for both sync and async operations.
PARAMETER | DESCRIPTION |
---|---|
**data
|
Keyword arguments for model initialization.
TYPE:
|
Source code in swarmauri_standard/llms/LlamaCppModel.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
|
allowed_models
instance-attribute
allowed_models = allowed_models or get_allowed_models()
name
instance-attribute
name = name or allowed_models[0]
type
class-attribute
instance-attribute
type = 'LLMBase'
model_config
class-attribute
instance-attribute
model_config = ConfigDict(
extra="allow", arbitrary_types_allowed=True
)
id
class-attribute
instance-attribute
id = Field(default_factory=generate_id)
members
class-attribute
instance-attribute
members = None
owners
class-attribute
instance-attribute
owners = None
host
class-attribute
instance-attribute
host = None
default_logger
class-attribute
default_logger = None
logger
class-attribute
instance-attribute
logger = None
version
class-attribute
instance-attribute
version = '0.1.0'
api_key
class-attribute
instance-attribute
api_key = None
timeout
class-attribute
instance-attribute
timeout = 600.0
include_usage
class-attribute
instance-attribute
include_usage = True
BASE_URL
class-attribute
instance-attribute
BASE_URL = None
predict
predict(
conversation,
temperature=0.7,
max_tokens=256,
enable_json=False,
stop=None,
)
Sends a synchronous request to generate a response from the model.
PARAMETER | DESCRIPTION |
---|---|
conversation
|
The conversation object containing message history.
TYPE:
|
temperature
|
Sampling temperature for response generation.
TYPE:
|
max_tokens
|
Maximum number of tokens to generate.
TYPE:
|
enable_json
|
Flag for enabling JSON response format.
TYPE:
|
stop
|
Stop sequences for the response.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Conversation
|
Updated conversation with the model's response.
TYPE:
|
Source code in swarmauri_standard/llms/LlamaCppModel.py
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
|
apredict
async
apredict(
conversation,
temperature=0.7,
max_tokens=256,
enable_json=False,
stop=None,
)
Sends an asynchronous request to generate a response from the model.
PARAMETER | DESCRIPTION |
---|---|
conversation
|
The conversation object containing message history.
TYPE:
|
temperature
|
Sampling temperature for response generation.
TYPE:
|
max_tokens
|
Maximum number of tokens to generate.
TYPE:
|
enable_json
|
Flag for enabling JSON response format.
TYPE:
|
stop
|
Stop sequences for the response.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Conversation
|
Updated conversation with the model's response.
TYPE:
|
Source code in swarmauri_standard/llms/LlamaCppModel.py
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
|
stream
stream(
conversation, temperature=0.7, max_tokens=256, stop=None
)
Streams response content from the model synchronously.
PARAMETER | DESCRIPTION |
---|---|
conversation
|
The conversation object containing message history.
TYPE:
|
temperature
|
Sampling temperature for response generation.
TYPE:
|
max_tokens
|
Maximum number of tokens to generate.
TYPE:
|
stop
|
Stop sequences for the response.
TYPE:
|
YIELDS | DESCRIPTION |
---|---|
str
|
Chunks of content from the model's response.
TYPE::
|
Source code in swarmauri_standard/llms/LlamaCppModel.py
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
|
astream
async
astream(
conversation, temperature=0.7, max_tokens=256, stop=None
)
Streams response content from the model asynchronously.
PARAMETER | DESCRIPTION |
---|---|
conversation
|
The conversation object containing message history.
TYPE:
|
temperature
|
Sampling temperature for response generation.
TYPE:
|
max_tokens
|
Maximum number of tokens to generate.
TYPE:
|
stop
|
Stop sequences for the response.
TYPE:
|
YIELDS | DESCRIPTION |
---|---|
str
|
Chunks of content from the model's response.
TYPE::
|
Source code in swarmauri_standard/llms/LlamaCppModel.py
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
|
batch
batch(
conversations,
temperature=0.7,
max_tokens=256,
enable_json=False,
stop=None,
)
Processes multiple conversations in batch synchronously.
PARAMETER | DESCRIPTION |
---|---|
conversations
|
List of conversation objects.
TYPE:
|
temperature
|
Sampling temperature for response generation.
TYPE:
|
max_tokens
|
Maximum number of tokens to generate.
TYPE:
|
enable_json
|
Flag for enabling JSON response format.
TYPE:
|
stop
|
Stop sequences for responses.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
List[Conversation]
|
List[Conversation]: List of updated conversations with model responses. |
Source code in swarmauri_standard/llms/LlamaCppModel.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 |
|
abatch
async
abatch(
conversations,
temperature=0.7,
max_tokens=256,
enable_json=False,
stop=None,
max_concurrent=5,
)
Processes multiple conversations asynchronously, with concurrency control.
PARAMETER | DESCRIPTION |
---|---|
conversations
|
List of conversation objects.
TYPE:
|
temperature
|
Sampling temperature for response generation.
TYPE:
|
max_tokens
|
Maximum number of tokens to generate.
TYPE:
|
enable_json
|
Flag for enabling JSON response format.
TYPE:
|
stop
|
Stop sequences for responses.
TYPE:
|
max_concurrent
|
Maximum number of concurrent tasks.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
List[Conversation]
|
List[Conversation]: List of updated conversations with model responses. |
Source code in swarmauri_standard/llms/LlamaCppModel.py
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 |
|
get_allowed_models
get_allowed_models()
Queries the LLMProvider API endpoint to get the list of allowed models.
RETURNS | DESCRIPTION |
---|---|
List[str]
|
List[str]: List of allowed model identifiers. |
Source code in swarmauri_standard/llms/LlamaCppModel.py
354 355 356 357 358 359 360 361 362 363 364 |
|
register_model
classmethod
register_model()
Decorator to register a base model in the unified registry.
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the model class.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 |
|
register_type
classmethod
register_type(resource_type=None, type_name=None)
Decorator to register a subtype under one or more base models in the unified registry.
PARAMETER | DESCRIPTION |
---|---|
resource_type
|
The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used.
TYPE:
|
type_name
|
An optional custom type name for the subtype.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
Callable
|
A decorator function that registers the subtype.
TYPE:
|
Source code in swarmauri_base/DynamicBase.py
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 |
|
model_validate_toml
classmethod
model_validate_toml(toml_data)
Validate a model from a TOML string.
Source code in swarmauri_base/TomlMixin.py
12 13 14 15 16 17 18 19 20 21 22 23 24 |
|
model_dump_toml
model_dump_toml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a TOML representation of the model.
Source code in swarmauri_base/TomlMixin.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
|
model_validate_yaml
classmethod
model_validate_yaml(yaml_data)
Validate a model from a YAML string.
Source code in swarmauri_base/YamlMixin.py
11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
model_dump_yaml
model_dump_yaml(
fields_to_exclude=None, api_key_placeholder=None
)
Return a YAML representation of the model.
Source code in swarmauri_base/YamlMixin.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
model_post_init
model_post_init(logger=None)
Assign a logger instance after model initialization.
Source code in swarmauri_base/LoggerMixin.py
23 24 25 26 27 28 |
|
add_allowed_model
add_allowed_model(model)
Add a new model to the list of allowed models.
RAISES | DESCRIPTION |
---|---|
ValueError
|
If the model is already in the allowed models list. |
Source code in swarmauri_base/llms/LLMBase.py
36 37 38 39 40 41 42 43 44 45 |
|
remove_allowed_model
remove_allowed_model(model)
Remove a model from the list of allowed models.
RAISES | DESCRIPTION |
---|---|
ValueError
|
If the model is not in the allowed models list. |
Source code in swarmauri_base/llms/LLMBase.py
47 48 49 50 51 52 53 54 55 56 |
|