yoker
Contents
Installation
Quick Start
CLI Reference
Getting Started: From Zero to Hello Agent
Getting Started with Yoker
Getting Started with Ollama
Getting Started with Google Gemini
Creating Agentic Packages
Model Catalog
Using Plugins
Yoker Project Rationale
Yoker: Naming Documentation
API Reference
yoker
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
A
Agent (class in yoker.core)
agent() (in module yoker.api)
AGENT_FINISHED (yoker.events.EventType attribute)
agent_id (yoker.events.AgentFinishedEvent attribute)
,
[1]
(yoker.events.AgentSpawnedEvent attribute)
,
[1]
(yoker.events.SessionEvent attribute)
,
[1]
AGENT_MESSAGE (yoker.events.EventType attribute)
AGENT_SPAWNED (yoker.events.EventType attribute)
AgentFinishedEvent (class in yoker.events)
AgentMessageEvent (class in yoker.events)
AgentSpawnedEvent (class in yoker.events)
arguments (yoker.events.ToolCallEvent attribute)
B
backend (yoker.tools.WebFetchError attribute)
(yoker.tools.WebSearchError attribute)
backends (yoker.tools.ToolContext attribute)
,
[1]
block_private_cidrs (yoker.tools.WebGuardrailConfig attribute)
,
[1]
C
cause (yoker.tools.WebFetchError attribute)
(yoker.tools.WebSearchError attribute)
close() (yoker.events.EventRecorder method)
command (yoker.events.CommandEvent attribute)
COMMAND (yoker.events.EventType attribute)
CommandEvent (class in yoker.events)
config (yoker.tools.ToolContext attribute)
,
[1]
content (yoker.events.AgentMessageEvent attribute)
,
[1]
(yoker.events.ToolContentEvent attribute)
,
[1]
(yoker.tools.FetchedContent attribute)
,
[1]
CONTENT_CHUNK (yoker.events.EventType attribute)
CONTENT_END (yoker.events.EventType attribute)
content_metadata (yoker.tools.ToolResult attribute)
,
[1]
CONTENT_START (yoker.events.EventType attribute)
content_type (yoker.events.ContentChunkEvent attribute)
,
[1]
(yoker.events.ToolContentEvent attribute)
,
[1]
(yoker.tools.FetchedContent attribute)
,
[1]
ContentChunkEvent (class in yoker.events)
ContentEndEvent (class in yoker.events)
ContentStartEvent (class in yoker.events)
D
definition_name (yoker.events.AgentSpawnedEvent attribute)
,
[1]
description (yoker.tools.Text attribute)
,
[1]
deserialize_event() (in module yoker.events)
do() (in module yoker.api)
(yoker.core.Agent method)
domain_allowlist (yoker.tools.WebGuardrailConfig attribute)
,
[1]
domain_blocklist (yoker.tools.WebGuardrailConfig attribute)
,
[1]
E
error (yoker.tools.ToolResult attribute)
,
[1]
error_type (yoker.tools.WebFetchError attribute)
eval_count (yoker.events.TurnEndEvent attribute)
Event (class in yoker.events)
event (yoker.events.SessionEvent attribute)
,
[1]
EventRecorder (class in yoker.events)
EventType (class in yoker.events)
F
fetch() (yoker.tools.OllamaWebFetchBackend method)
(yoker.tools.WebFetchBackend method)
FetchedContent (class in yoker.tools)
filter_skills() (yoker.core.Agent static method)
find_tools() (yoker.tools.ToolRegistry method)
from_dict() (yoker.tools.FetchedContent class method)
(yoker.tools.SearchResult class method)
from_id (yoker.events.AgentMessageEvent attribute)
,
[1]
G
get_agent() (yoker.session.Session method)
get_backend() (yoker.session.Session method)
get_schemas() (yoker.tools.ToolRegistry method)
Guardrail (class in yoker.tools)
guardrail (yoker.core.Agent property)
GuardType (class in yoker.tools)
I
inject_skill_context() (yoker.core.Agent method)
inject_tools() (yoker.session.Session method)
input_tokens (yoker.events.TurnEndEvent attribute)
M
max_concurrent_requests (yoker.tools.WebGuardrailConfig attribute)
,
[1]
max_query_length (yoker.tools.WebGuardrailConfig attribute)
,
[1]
message (yoker.events.TurnStartEvent attribute)
(yoker.tools.WebFetchError attribute)
(yoker.tools.WebSearchError attribute)
metadata (yoker.events.ToolContentEvent attribute)
,
[1]
(yoker.tools.FetchedContent attribute)
,
[1]
module
yoker.api
yoker.core
yoker.events
yoker.session
yoker.tools
N
names (yoker.tools.ToolRegistry property)
namespaces (yoker.tools.ToolRegistry property)
O
OllamaWebFetchBackend (class in yoker.tools)
OllamaWebSearchBackend (class in yoker.tools)
on_event() (yoker.core.Agent method)
(yoker.session.Session method)
operation (yoker.events.ToolContentEvent attribute)
,
[1]
output_tokens (yoker.events.TurnEndEvent attribute)
P
Path (class in yoker.tools)
path (yoker.events.ToolContentEvent attribute)
,
[1]
PATH (yoker.tools.GuardType attribute)
PathGuardrail (class in yoker.tools)
process() (in module yoker.api)
(yoker.core.Agent method)
prompt_eval_count (yoker.events.TurnEndEvent attribute)
Q
Query (class in yoker.tools)
QUERY (yoker.tools.GuardType attribute)
QueryWebGuardrail (class in yoker.tools)
R
reason (yoker.tools.ValidationResult attribute)
,
[1]
register() (yoker.tools.ToolRegistry method)
register_all() (yoker.tools.ToolRegistry method)
register_plugin_tools() (yoker.tools.ToolRegistry method)
release() (yoker.session.Session method)
release_concurrent() (yoker.tools.WebGuardrail method)
requests_per_hour (yoker.tools.WebGuardrailConfig attribute)
,
[1]
requests_per_minute (yoker.tools.WebGuardrailConfig attribute)
,
[1]
require_https (yoker.tools.WebGuardrailConfig attribute)
,
[1]
response (yoker.events.TurnEndEvent attribute)
result (yoker.events.CommandEvent attribute)
(yoker.events.ToolResultEvent attribute)
(yoker.tools.ToolResult attribute)
,
[1]
run_sync() (in module yoker.api)
S
search() (yoker.tools.OllamaWebSearchBackend method)
(yoker.tools.WebSearchBackend method)
SearchResult (class in yoker.tools)
send() (yoker.session.Session method)
serialize_event() (in module yoker.events)
Session (class in yoker.session)
session (yoker.tools.ToolContext attribute)
,
[1]
session() (in module yoker.api)
SESSION_END (yoker.events.EventType attribute)
session_id (yoker.events.AgentFinishedEvent attribute)
,
[1]
(yoker.events.AgentMessageEvent attribute)
,
[1]
(yoker.events.AgentSpawnedEvent attribute)
,
[1]
(yoker.events.SessionEndEvent attribute)
,
[1]
(yoker.events.SessionStartEvent attribute)
,
[1]
SESSION_START (yoker.events.EventType attribute)
SessionEndEvent (class in yoker.events)
SessionEvent (class in yoker.events)
SessionStartEvent (class in yoker.events)
shared (yoker.tools.ToolContext attribute)
,
[1]
snippet (yoker.tools.SearchResult attribute)
,
[1]
source (yoker.tools.FetchedContent attribute)
,
[1]
(yoker.tools.SearchResult attribute)
,
[1]
spawn() (yoker.session.Session method)
success (yoker.events.ToolResultEvent attribute)
(yoker.tools.ToolResult attribute)
,
[1]
T
Text (class in yoker.tools)
text (yoker.events.ContentChunkEvent attribute)
,
[1]
(yoker.events.ThinkingChunkEvent attribute)
TEXT (yoker.tools.GuardType attribute)
THINKING_CHUNK (yoker.events.EventType attribute)
THINKING_END (yoker.events.EventType attribute)
THINKING_START (yoker.events.EventType attribute)
ThinkingChunkEvent (class in yoker.events)
ThinkingEndEvent (class in yoker.events)
ThinkingStartEvent (class in yoker.events)
timeout_seconds (yoker.tools.WebGuardrailConfig attribute)
,
[1]
timestamp (yoker.events.Event attribute)
title (yoker.tools.FetchedContent attribute)
,
[1]
(yoker.tools.SearchResult attribute)
,
[1]
to_dict() (yoker.tools.FetchedContent method)
(yoker.tools.SearchResult method)
to_id (yoker.events.AgentMessageEvent attribute)
,
[1]
TOOL_CALL (yoker.events.EventType attribute)
tool_calls_count (yoker.events.TurnEndEvent attribute)
TOOL_CONTENT (yoker.events.EventType attribute)
tool_name (yoker.events.ToolCallEvent attribute)
(yoker.events.ToolContentEvent attribute)
,
[1]
(yoker.events.ToolResultEvent attribute)
TOOL_RESULT (yoker.events.EventType attribute)
ToolCallEvent (class in yoker.events)
ToolContentEvent (class in yoker.events)
ToolContext (class in yoker.tools)
ToolRegistry (class in yoker.tools)
ToolResult (class in yoker.tools)
ToolResultEvent (class in yoker.events)
tools (yoker.tools.ToolRegistry property)
total_duration_ms (yoker.events.TurnEndEvent attribute)
total_length (yoker.events.ContentEndEvent attribute)
(yoker.events.ThinkingEndEvent attribute)
TURN_END (yoker.events.EventType attribute)
TURN_START (yoker.events.EventType attribute)
TurnEndEvent (class in yoker.events)
TurnStartEvent (class in yoker.events)
type (yoker.events.Event attribute)
U
Url (class in yoker.tools)
url (yoker.tools.FetchedContent attribute)
,
[1]
URL (yoker.tools.GuardType attribute)
url (yoker.tools.SearchResult attribute)
,
[1]
(yoker.tools.WebFetchError attribute)
UrlWebGuardrail (class in yoker.tools)
V
valid (yoker.tools.ValidationResult attribute)
,
[1]
validate() (yoker.tools.Guardrail method)
(yoker.tools.PathGuardrail method)
(yoker.tools.UrlWebGuardrail method)
(yoker.tools.WebGuardrail method)
ValidationResult (class in yoker.tools)
W
WebFetchBackend (class in yoker.tools)
WebFetchError
WebGuardrail (class in yoker.tools)
WebGuardrailConfig (class in yoker.tools)
WebSearchBackend (class in yoker.tools)
WebSearchError
Y
yoker.api
module
yoker.core
module
yoker.events
module
yoker.session
module
yoker.tools
module
yoker_type (yoker.tools.Path attribute)
(yoker.tools.Query attribute)
(yoker.tools.Text attribute)
,
[1]
(yoker.tools.Url attribute)