cohere.extractors¶
A class for extracting structured information using Cohere chat models.
BaseExtractor
¶
Bases: BasePrompt
, Generic[BaseCallT, BaseToolT, BaseToolStreamT, ExtractedTypeT]
, ABC
The base abstract interface for extracting structured information using LLMs.
Source code in mirascope/base/extractors.py
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 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 |
|
extract(retries=0)
abstractmethod
¶
extract_async(retries=0)
abstractmethod
async
¶
from_prompt(prompt_type, call_params, *, extract_schema=None)
classmethod
¶
Returns an extractor_type generated dynamically from this base extractor.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
prompt_type |
type[BasePromptT]
|
The prompt class to use for the extractor. Properties and class variables of this class will be used to create the new extractor class. Must be a class that can be instantiated. |
required |
call_params |
BaseCallParams
|
The call params to use for the extractor. |
required |
extract_schema |
Optional[ExtractedType]
|
The extract schema to use for the extractor. If none, the extractor will use the class' extract_schema. |
None
|
Returns:
Type | Description |
---|---|
type[BasePromptT]
|
A new extractor class with new extractor type. |
Source code in mirascope/base/extractors.py
CohereCall
¶
Bases: BaseCall[CohereCallResponse, CohereCallResponseChunk, CohereTool, ChatMessage]
A base class for calling Cohere's chat models.
Example:
from mirascope.cohere import CohereCall
class BookRecommender(CohereCall):
prompt_template = "Please recommend a {genre} book"
genre: str
response = BookRecommender(genre="fantasy").call()
print(response.content)
#> There are many great books to read, it ultimately depends...
Source code in mirascope/cohere/calls.py
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 |
|
call(retries=0, **kwargs)
¶
Makes a call to the model using this CohereCall
instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
CohereCallResponse
|
A |
Source code in mirascope/cohere/calls.py
call_async(retries=0, **kwargs)
async
¶
Makes an asynchronous call to the model using this CohereCall
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
CohereCallResponse
|
An |
Source code in mirascope/cohere/calls.py
messages()
¶
Returns the template as a formatted list of messages.
Source code in mirascope/cohere/calls.py
stream(retries=0, **kwargs)
¶
Streams the response for a call using this CohereCall
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Yields:
Type | Description |
---|---|
CohereCallResponseChunk
|
A |
Source code in mirascope/cohere/calls.py
stream_async(retries=0, **kwargs)
async
¶
Streams the response for an asynchronous call using this CohereCall
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Yields:
Type | Description |
---|---|
AsyncGenerator[CohereCallResponseChunk, None]
|
A |
Source code in mirascope/cohere/calls.py
CohereCallParams
¶
Bases: BaseCallParams[CohereTool]
The parameters to use when calling the Cohere chat API.
Source code in mirascope/cohere/types.py
kwargs(tool_type=CohereTool, exclude=None)
¶
Returns the keyword argument call parameters.
Source code in mirascope/cohere/types.py
CohereExtractor
¶
Bases: BaseExtractor[CohereCall, CohereTool, Any, T]
, Generic[T]
A class for extracting structured information using Cohere chat models.
Example:
from typing import Literal, Type
from mirascope.cohere import CohereExtractor
from pydantic import BaseModel
class TaskDetails(BaseModel):
title: str
priority: Literal["low", "normal", "high"]
due_date: str
class TaskExtractor(CohereExtractor[TaskDetails]):
extract_schema: Type[TaskDetails] = TaskDetails
prompt_template = """
Please extract the task details:
{task}
"""
task: str
task_description = "Submit quarterly report by next Friday. Task is high priority."
task = TaskExtractor(task=task_description).extract(retries=3)
assert isinstance(task, TaskDetails)
print(task)
#> title='Submit quarterly report' priority='high' due_date='next Friday'
Source code in mirascope/cohere/extractors.py
extract(retries=0, **kwargs)
¶
Extracts extract_schema
from the Cohere call response.
The extract_schema
is converted into an CohereTool
, complete with a
description of the tool, all of the fields, and their types. This allows us to
take advantage of Cohere's tool/function calling functionality to extract
information from a prompt according to the context provided by the BaseModel
schema.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
retries |
Union[int, Retrying]
|
The maximum number of times to retry the query on validation error. |
0
|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
T
|
The |
Raises:
Type | Description |
---|---|
AttributeError
|
if there is no tool in the call creation. |
ValidationError
|
if the schema cannot be instantiated from the completion. |
Source code in mirascope/cohere/extractors.py
extract_async(retries=0, **kwargs)
async
¶
Asynchronously extracts extract_schema
from the Cohere call response.
The extract_schema
is converted into an CohereTool
, complete with a
description of the tool, all of the fields, and their types. This allows us to
take advantage of Cohere's tool/function calling functionality to extract
information from a prompt according to the context provided by the BaseModel
schema.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
retries |
Union[int, AsyncRetrying]
|
The maximum number of times to retry the query on validation error. |
0
|
**kwargs |
Any
|
Additional keyword arguments parameters to pass to the call. These
will override any existing arguments in |
{}
|
Returns:
Type | Description |
---|---|
T
|
The |
Raises:
Type | Description |
---|---|
AttributeError
|
if there is no tool in the call creation. |
ValidationError
|
if the schema cannot be instantiated from the completion. |
Source code in mirascope/cohere/extractors.py
CohereTool
¶
Bases: BaseTool[ToolCall]
A base class for easy use of tools with the Cohere chat client.
CohereTool
internally handles the logic that allows you to use tools with simple
calls such as CohereCallResponse.tool
or CohereTool.fn
, as seen in the
examples below.
Example:
from mirascope.cohere import CohereCall, CohereCallParams
def animal_matcher(fav_food: str, fav_color: str) -> str:
"""Tells you your most likely favorite animal from personality traits.
Args:
fav_food: your favorite food.
fav_color: your favorite color.
Returns:
The animal most likely to be your favorite based on traits.
"""
return "Your favorite animal is the best one, a frog."
class AnimalMatcher(CohereCall):
prompt_template = """
Tell me my favorite animal if my favorite food is {food} and my
favorite color is {color}.
"""
food: str
color: str
call_params = CohereCallParams(tools=[animal_matcher])
response = AnimalMatcher(food="pizza", color="red").call
tool = response.tool
print(tool.fn(**tool.args))
#> Your favorite animal is the best one, a frog.
Source code in mirascope/cohere/tools.py
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 |
|
from_base_type(base_type)
classmethod
¶
Constructs a CohereTool
type from a BaseType
type.
from_fn(fn)
classmethod
¶
from_model(model)
classmethod
¶
Constructs a CohereTool
type from a BaseModel
type.
from_tool_call(tool_call)
classmethod
¶
Extracts an instance of the tool constructed from a tool call response.
Given ToolCall
from an Cohere chat completion response, takes its function
arguments and creates an CohereTool
instance from it.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
tool_call |
ToolCall
|
The |
required |
Returns:
Type | Description |
---|---|
CohereTool
|
An instance of the tool constructed from the tool call. |
Raises:
Type | Description |
---|---|
ValidationError
|
if the tool call doesn't match the tool schema. |
Source code in mirascope/cohere/tools.py
tool_schema()
classmethod
¶
Constructs a tool schema for use with the Cohere chat client.
A Mirascope CohereTool
is deconstructed into a JSON schema, and relevant keys
are renamed to match the Cohere tool schema used to make function/tool calls in
the Cohere chat API.
Returns:
Type | Description |
---|---|
Tool
|
The constructed tool schema. |