LLM Provider Interface¶
This module defines the abstract base class for all LLM providers.
cogitator.model.base.BaseLLM
¶
Bases: ABC
Abstract base class defining the interface for LLM providers.
Source code in cogitator/model/base.py
16 17 18 19 20 21 22 23 24 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 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 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 157 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 193 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 239 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 283 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 315 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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
|
__init__()
¶
get_last_prompt_tokens()
¶
get_last_completion_tokens()
¶
generate(prompt, **kwargs)
abstractmethod
¶
Generates a single text completion for the given prompt.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The input text prompt. |
required |
**kwargs
|
Any
|
Additional provider-specific parameters (e.g., temperature, max_tokens, stop sequences, seed). |
{}
|
Returns:
Type | Description |
---|---|
str
|
The generated text completion as a string. |
Raises:
Type | Description |
---|---|
RuntimeError
|
If the generation fails after retries or due to API errors. |
Source code in cogitator/model/base.py
generate_async(prompt, **kwargs)
abstractmethod
async
¶
Asynchronously generates a single text completion for the given prompt.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The input text prompt. |
required |
**kwargs
|
Any
|
Additional provider-specific parameters. |
{}
|
Returns:
Type | Description |
---|---|
str
|
The generated text completion as a string. |
Raises:
Type | Description |
---|---|
RuntimeError
|
If the asynchronous generation fails. |
Source code in cogitator/model/base.py
generate_stream(prompt, **kwargs)
abstractmethod
¶
Generates a stream of text chunks for the given prompt.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The input text prompt. |
required |
**kwargs
|
Any
|
Additional provider-specific parameters. |
{}
|
Yields:
Type | Description |
---|---|
str
|
Strings representing chunks of the generated text. |
Raises:
Type | Description |
---|---|
RuntimeError
|
If starting the stream generation fails. |
Source code in cogitator/model/base.py
generate_stream_async(prompt, **kwargs)
abstractmethod
async
¶
Asynchronously generates a stream of text chunks for the given prompt.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The input text prompt. |
required |
**kwargs
|
Any
|
Additional provider-specific parameters. |
{}
|
Yields:
Type | Description |
---|---|
AsyncIterator[str]
|
Strings representing chunks of the generated text asynchronously. |
Raises:
Type | Description |
---|---|
RuntimeError
|
If starting the asynchronous stream generation fails. |
Source code in cogitator/model/base.py
generate_json(prompt, response_model, retries=2, **kwargs)
¶
Generates a response and parses it into a Pydantic model instance.
Uses _generate_json_internal
and attempts to parse the result.
Retries on validation or decoding errors. Also updates internal token counts.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The input prompt, often instructing the LLM to respond in JSON. |
required |
response_model
|
Type[BaseModel]
|
The Pydantic model class to validate the response against. |
required |
retries
|
int
|
The number of times to retry on parsing/validation failure. |
2
|
**kwargs
|
Any
|
Additional provider-specific parameters for generation. |
{}
|
Returns:
Type | Description |
---|---|
BaseModel
|
An instance of the |
Raises:
Type | Description |
---|---|
RuntimeError
|
If parsing fails after all retries. |
ValidationError
|
If the final response does not match the |
JSONDecodeError
|
If the final response is not valid JSON. |
Source code in cogitator/model/base.py
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 239 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 283 284 285 286 287 288 289 290 |
|
generate_json_async(prompt, response_model, retries=2, **kwargs)
async
¶
Asynchronously generates a response and parses it into a Pydantic model instance.
Uses _generate_json_internal_async
and attempts to parse the result.
Retries on validation or decoding errors. Also updates internal token counts.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt
|
str
|
The input prompt, often instructing the LLM to respond in JSON. |
required |
response_model
|
Type[BaseModel]
|
The Pydantic model class to validate the response against. |
required |
retries
|
int
|
The number of times to retry on parsing/validation failure. |
2
|
**kwargs
|
Any
|
Additional provider-specific parameters for generation. |
{}
|
Returns:
Type | Description |
---|---|
BaseModel
|
An instance of the |
Raises:
Type | Description |
---|---|
RuntimeError
|
If parsing fails after all retries. |
ValidationError
|
If the final response does not match the |
JSONDecodeError
|
If the final response is not valid JSON. |
Source code in cogitator/model/base.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 |
|