Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that Chat.initClient and Prompt.initClient are Client.inti #33

Merged
merged 1 commit into from
Dec 28, 2024
Merged

Clarify that Chat.initClient and Prompt.initClient are Client.inti #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package/Chat.roc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Client : Client.Client
## ```
## client = Chat.initClient { apiKey: "your_openrouter_api_key" }
## ```
## Same as `Client.init`.
initClient = Client.init

## The OpenAI ChatML standard message used to query the AI model.
Expand Down
7 changes: 5 additions & 2 deletions package/Prompt.roc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,11 @@ PromptResponseBody : {
},
}

## Initialize the OpenRouter API client with the required API key.
## Other parameters may optionally be set during initialization, or assigned later using the Client module setters.
## Initialize the OpenRouter API client with the required API key. All parameters besides apiKey are completely optional, and may be set during initialization, assigned later, or left as their defaults.
## ```
## client = Chat.initClient { apiKey: "your_openrouter_api_key" }
## ```
## Same as `Client.init`.
initClient = Client.init

## Create a request object to be sent with basic-cli's Http.send using a prompt string
Expand Down