Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

updates to README #125

Merged
merged 2 commits into from
Jun 1, 2024
Merged

updates to README #125

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43ae88e
fix minor typos in README.md
petrus-jvrensburg May 30, 2024
eaa50be
be more explicit about API & Bumblebee support
petrus-jvrensburg May 30, 2024
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This library is aimed at assisting in the development of those types of applicat

## Documentation

The online documentation can [found here](https://hexdocs.pm/langchain).
The online documentation can be [found here](https://hexdocs.pm/langchain).

## Demo

Expand Down Expand Up @@ -58,7 +58,7 @@ end

Currently, the library is written to use the `Req` library for making API calls.

To make API calls, it is necessary to configure the API keys for the services you connect with. At this time, the library only supports ChatGPT and the OpenAI API key.
You can configure an _organization ID_, and _API key_ for OpenAI's API, but this library also works with [other compatible APIs](#alternative-openai-compatible-apis) as well as [local models running on Bumblebee](#bumblebee-chat-support).

`config/config.exs`:

Expand Down Expand Up @@ -150,7 +150,7 @@ IO.puts(message.content)

### Alternative OpenAI compatible APIs

There are several of services or self-hosted applications that provide an OpenAI compatible API for ChatGPT-like behavior. To use a service like that, the `endpoint` of the `ChatOpenAI` struct can be pointed to an API compatible `endpoint` for chats.
There are several services or self-hosted applications that provide an OpenAI compatible API for ChatGPT-like behavior. To use a service like that, the `endpoint` of the `ChatOpenAI` struct can be pointed to an API compatible `endpoint` for chats.

For example, if a locally running service provided that feature, the following code could connect to the service:

Expand Down