A tool whose parameters may be a raw JSON Schema (json_schema):
its handler then gets the parameters undecoded.
Attributes#
| Attribute | Type | Description |
|---|---|---|
json_schema | JsonSchema | None = None |
Functions#
__init__#
__init__(name, parameters_schema, success_schema, failure_schema, failure_mode='error', description=None, needs_approval=None, annotations=Context.empty(), to_model_output=None, json_schema=None) -> None| Parameter | Type | Description |
|---|---|---|
name | N_co | |
parameters_schema | S.Top | |
success_schema | S.Top | |
failure_schema | S.Top | |
failure_mode | FailureMode = 'error' | |
description | str | None = None | |
needs_approval | NeedsApproval | None = None | |
annotations | Context[Any] = Context.empty() | |
to_model_output | ToModelOutput | None = None | |
json_schema | JsonSchema | None = None |
set_parameters#
set_parameters[PP](schema) -> Tool[N_co, PP, S_co, F_co, HE_co, R_co]| Parameter | Type | Description |
|---|---|---|
schema | S.Codec[PP, Any, Any, Any] |
Returns Tool[N_co, PP, S_co, F_co, HE_co, R_co]
def set_parameters[PP](
self, schema: S.Codec[PP, Any, Any, Any]
) -> Tool[N_co, PP, S_co, F_co, HE_co, R_co]:
return cast("Any", replace(self, parameters_schema=schema, json_schema=None))handler#
handler[NN: LiteralString, PP, SS, FF, RR](fn) -> Handler[NN]The handler fn for this tool; it may fail with the tool's
failure, an AiError or an AI error reason.
| Parameter | Type | Description |
|---|---|---|
fn | Callable[[PP, HandlerContext[SS]], Effect[SS, FF | AiError | AnyReason, RR]] |
Returns Handler[NN]
def handler[NN: LiteralString, PP, SS, FF, RR](
self: Tool[NN, PP, SS, FF, Any, RR],
fn: Callable[[PP, HandlerContext[SS]], Effect[SS, FF | AiError | AnyReason, RR]],
) -> Handler[NN]:
"""The handler ``fn`` for this tool; it may fail with the tool's
failure, an ``AiError`` or an AI error reason."""
return Handler(self.name, self.id, fn)set_needs_approval#
set_needs_approval(needs_approval) -> Self| Parameter | Type | Description |
|---|---|---|
needs_approval | NeedsApproval |
Returns Self
def set_needs_approval(self, needs_approval: NeedsApproval) -> Self:
return replace(self, needs_approval=needs_approval)add_dependency#
add_dependency[T](tag) -> Tool[N_co, P_co, S_co, F_co, HE_co, R_co | T]The same tool, whose handler may also need tag's service.
| Parameter | Type | Description |
|---|---|---|
tag | type[Tag[Any] | T] |
Returns Tool[N_co, P_co, S_co, F_co, HE_co, R_co | T]
def add_dependency[T](
self, tag: type[Tag[Any] | T]
) -> Tool[N_co, P_co, S_co, F_co, HE_co, R_co | T]:
"""The same tool, whose handler may also need ``tag``'s service."""
return cast("Any", replace(self))set_success#
set_success[SS](schema) -> Tool[N_co, P_co, SS, F_co, HE_co, R_co]| Parameter | Type | Description |
|---|---|---|
schema | S.Codec[SS, Any, Any, Any] |
Returns Tool[N_co, P_co, SS, F_co, HE_co, R_co]
def set_success[SS](
self, schema: S.Codec[SS, Any, Any, Any]
) -> Tool[N_co, P_co, SS, F_co, HE_co, R_co]:
return cast("Any", replace(self, success_schema=schema, to_model_output=None))set_failure#
set_failure[FF](schema) -> Tool[N_co, P_co, S_co, FF, Any, R_co]| Parameter | Type | Description |
|---|---|---|
schema | S.Codec[FF, Any, Any, Any] |
Returns Tool[N_co, P_co, S_co, FF, Any, R_co]
def set_failure[FF](
self, schema: S.Codec[FF, Any, Any, Any]
) -> Tool[N_co, P_co, S_co, FF, Any, R_co]:
return cast("Any", replace(self, failure_schema=schema))annotate#
annotate[V](tag, value) -> Self| Parameter | Type | Description |
|---|---|---|
tag | type[Tag[V]] | |
value | V |
Returns Self
def annotate[V](self, tag: type[Tag[V]], value: V) -> Self:
return replace(self, annotations=self.annotations.add(tag, value))annotate_merge#
annotate_merge(context) -> Self| Parameter | Type | Description |
|---|---|---|
context | Context[Any] |
Returns Self
def annotate_merge(self, context: Context[Any]) -> Self:
return replace(self, annotations=self.annotations.merge(context))