Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jxnl authored Jan 2, 2024
1 parent 12a429a commit 9e81b2a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# instructor-js

This is a WIP of the [instructor](https://github.com/jxnl/instructor) project implemented in JavaScript.
I am not a JavaScript developer, so this is a learning project for me, if you're interested in contributing seriously to this project, please contact me on [Twitter](https://twitter.com/jxnlco)

This is a WIP of the port of the [Instructor Python Library](https://github.com/jxnl/instructor) by [@jxnlco](https://twitter.com/jxnlco).
This library brings structured prompting to LLMs. Instead of receiving text as output, Instructor will coax the LLM to output valid JSON that maps directly to the provided Ecto schema.
If the LLM fails to do so, or provides values that do not pass your validations, it will provide you utilities to automatically retry with the LLM to correct errors.
The simple goal of this project is to provide a simple, type-safe, and easy to use interface for the OpenAI API.

```ts
Expand Down

0 comments on commit 9e81b2a

Please sign in to comment.