Return to Roc packages
Documentation
Chat
▶
Client
Message
ChatResponseBody
build_http_request
new_client
decode_response
decode_top_message_choice
decode_error_response
update_messages
add_system_message
add_user_message
add_assistant_message
Client
▶
Client
default_model
default_url
new
Api
get_api_url
set_model
set_api
set_api_key
set_timeout_ms
set_provider_order
set_temperature
set_top_p
set_top_k
set_frequency_penalty
set_presence_penalty
set_repetition_penalty
set_min_p
set_top_a
set_seed
set_max_tokens
set_models
set_route
set_tools
set_system
set_messages
set_stream
Prompt
▶
Client
PromptRequestBody
PromptResponseBody
new_client
build_http_request
build_request_body
encode_request_body
decode_response
decode_top_text_choice
decode_error_response
format_llama_prompt
format_llama_prompt_with_history
update_llama_conversation_history
Tools
▶
Tool
ToolCall
handle_tool_calls!
dispatch_tool_calls!
call_tool!
build_tool
Toolkit.FileSystem
▶
list_directory
list_file_tree
read_file_contents
write_file_contents
Toolkit.OpenWeatherMap
▶
geocoding
current_weather
Toolkit.Roc
▶
roc
roc_check
roc_test
roc_start
Toolkit.Serper
▶
serper
Toolkit.UtcTime
▶
utc_now
Toolkit.Wikipedia
▶
wikipedia_search
wikipedia_parse
Toolkit.WolframAlpha
▶
wolfram_short_answer
Toolkit.WorldTimeApi
▶
current_time
(press
s
)
Chat
.
Client
: Client.Client
Chat
.
Message
Chat
.
ChatResponseBody
Chat
.
build_http_request
: Client, { tool_choice ? ToolChoice } -> RequestObject
Chat
.
new_client
Chat
.
decode_response
: List U8 -> Result ChatResponseBody [TooShort]
Chat
.
decode_top_message_choice
: List U8 -> Result Message [ NoChoices, ApiError ApiError, BadJson Str ]
Chat
.
decode_error_response
Chat
.
update_messages
: Client, HttpResponse -> Result Client [ NoChoices, ApiError ApiError, BadJson Str, HttpError { body : Str, status : U16 } ]
Chat
.
add_system_message
: Client, Str, { cached ? Bool } -> Client
Chat
.
add_user_message
: Client, Str, { cached ? Bool } -> Client
Chat
.
add_assistant_message
: Client, Str, { cached ? Bool } -> Client
Client
.
Client
Client
.
default_model
Client
.
default_url
Client
.
new
: { api ? Api, api_key : Str, model ? Str, timeout_ms ? TimeoutConfig, provider_order ? List Str, temperature ? F32, top_p ? F32, top_k ? U64, frequency_penalty ? F32, presence_penalty ? F32, repetition_penalty ? F32, min_p ? F32, top_a ? F32, seed ? U64, max_tokens ? U64, models ? List Str, route ? [ UseFallback, NoFallback ], tools ? List Tool, system ? Str, stream ? Bool } -> Client
Client
.
Api
Client
.
get_api_url
: Client -> Str
Client
.
set_model
: Client, Str -> Client
Client
.
set_api
: Client, Api -> Client
Client
.
set_api_key
: Client, Str -> Client
Client
.
set_timeout_ms
: Client, TimeoutConfig -> Client
Client
.
set_provider_order
: Client, List Str -> Client
Client
.
set_temperature
: Client, F32 -> Client
Client
.
set_top_p
: Client, F32 -> Client
Client
.
set_top_k
: Client, U64 -> Client
Client
.
set_frequency_penalty
: Client, F32 -> Client
Client
.
set_presence_penalty
: Client, F32 -> Client
Client
.
set_repetition_penalty
: Client, F32 -> Client
Client
.
set_min_p
: Client, F32 -> Client
Client
.
set_top_a
: Client, F32 -> Client
Client
.
set_seed
: Client, U64 -> Client
Client
.
set_max_tokens
: Client, U64 -> Client
Client
.
set_models
: Client, List Str -> Client
Client
.
set_route
: Client, [ UseFallback, NoFallback ] -> Client
Client
.
set_tools
: Client, List Tool -> Client
Client
.
set_system
: Client, Str -> Client
Client
.
set_messages
: Client, List Message -> Client
Client
.
set_stream
: Client, Bool -> Client
Prompt
.
Client
: Client.Client
Prompt
.
PromptRequestBody
Prompt
.
PromptResponseBody
Prompt
.
new_client
Prompt
.
build_http_request
: Client, Str -> RequestObject
Prompt
.
build_request_body
: Client, Str -> PromptRequestBody
Prompt
.
encode_request_body
: PromptRequestBody -> List U8
Prompt
.
decode_response
: List U8 -> Result PromptResponseBody
Prompt
.
decode_top_text_choice
: List U8 -> Result Str [ ApiError ApiError, DecodingError, NoChoices, BadJson Str ]
Prompt
.
decode_error_response
Prompt
.
format_llama_prompt
: { prompt : Str, sys_message ? Str } -> Str
Prompt
.
format_llama_prompt_with_history
: Str, Str -> Str
Prompt
.
update_llama_conversation_history
: { prompt_str : Str, bot_reply : Str, conversation_history ? Str } -> Str
Tools
.
Tool
Tools
.
ToolCall
Tools
.
handle_tool_calls!
: Client, Dict Str (Str => Result Str ), { max_model_calls ? U32 } => Result Client
Tools
.
dispatch_tool_calls!
: List ToolCall, Dict Str (Str => Result Str ) => Result (List Message)
Tools
.
call_tool!
: ToolCall, (Str => Result Str err) => Result Message err
Tools
.
build_tool
: Str, Str, List { name : Str, type : Str, description : Str, required : Bool } -> Tool
Toolkit.FileSystem
.
list_directory
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.FileSystem
.
list_file_tree
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.FileSystem
.
read_file_contents
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.FileSystem
.
write_file_contents
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.OpenWeatherMap
.
geocoding
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.OpenWeatherMap
.
current_weather
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Roc
.
roc
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Roc
.
roc_check
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Roc
.
roc_test
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Roc
.
roc_start
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Serper
.
serper
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.UtcTime
.
utc_now
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Wikipedia
.
wikipedia_search
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.Wikipedia
.
wikipedia_parse
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.WolframAlpha
.
wolfram_short_answer
: { name : Str, handler! : Str => Result Str , tool : Tool }
Toolkit.WorldTimeApi
.
current_time
: { name : Str, handler! : Str => Result Str , tool : Tool }
Exposed Modules
LLM docs
Chat
Client
Prompt
Tools
Toolkit.FileSystem
Toolkit.OpenWeatherMap
Toolkit.Roc
Toolkit.Serper
Toolkit.UtcTime
Toolkit.Wikipedia
Toolkit.WolframAlpha
Toolkit.WorldTimeApi