Skip to content

Commit 240bf28

Browse files
committed
Release version 0.14.4
1 parent 6322075 commit 240bf28

File tree

185 files changed

+341
-317
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+341
-317
lines changed

.github/workflows/php.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
1-
name: Tests
21

3-
on:
4-
push:
5-
branches: [ "main" ]
6-
pull_request:
7-
branches: [ "main" ]
82

9-
permissions:
10-
contents: read
11-
12-
jobs:
133
build:
144
name: 'PHP ${{ matrix.php }} (Composer Flags: ${{ matrix.composer }})'
155

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,26 @@ Here's a simple CLI demo app using Instructor to extract structured data from te
1919

2020

2121

22+
## Instructor packages
23+
24+
This repository is a monorepo containing all Instructor's components (required and optional). It hosts all that you need to work with LLMs via Instructor.
25+
26+
Individual components are distributed also as standalone packages that can be used independently.
27+
28+
![image](docs/images/instructor-packages.png)
29+
30+
Links to read-only repositories of the individual packages:
31+
- [instructor-struct](https://github.com/cognesy/instructor-struct) - get dev friendly structured outputs from LLMs
32+
- [instructor-polyglot](https://github.com/cognesy/instructor-polyglot) - use single API for inference and embeddings across most of LLM providers, easily switch between them (e.g., develop on Ollama, switch to Groq in production)
33+
- [instructor-http-client](https://github.com/cognesy/instructor-http-client) - easily switch between underlying HTTP client libraries (out-of-the-box support for Guzzle, Symfony, Laravel)
34+
- [instructor-aux](https://github.com/cognesy/instructor-aux) - external tools and integrations, e.g. used by Instructor examples
35+
- [instructor-addons](https://github.com/cognesy/instructor-addons) - extra capabilities and common LLM-related problem solutions
36+
- [instructor-utils](https://github.com/cognesy/instructor-utils) - common utility classes used by Instructor packages
37+
- [instructor-setup](https://github.com/cognesy/instructor-setup) - CLI tool for publishing Instructor config files in your app
38+
- [instructor-hub](https://github.com/cognesy/instructor-hub) - CLI tool for browsing and running Instructor examples
39+
- [instructor-tell](https://github.com/cognesy/instructor-tell) - CLI tool for executing LLM prompts in your terminal
40+
41+
2242

2343
## Feature highlights
2444

docs-build/cookbook/introduction.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ $ ./bin/instructor hub list
4040

4141
### List Cookbooks
4242

43-
Run `./hub.sh list` you can see all the available tutorials and examples.
43+
Run `./bin/instructor hub list` you can see all the available tutorials and examples.
4444

4545
```bash
4646
$ ./bin/instructor hub list
4747
```
4848

4949
### Reading a Cookbook
5050

51-
To read a tutorial, you can run `./hub.sh show {id}` to see the full tutorial in the terminal.
51+
To read a tutorial, you can run `./bin/instructor hub show {id}` to see the full tutorial in the terminal.
5252

5353
```bash
5454
$ ./bin/instructor hub show {id}
@@ -60,7 +60,7 @@ Currently, there is no way to page through the tutorial - feel free to contribut
6060

6161
### Running a Cookbook
6262

63-
To run a tutorial, you run `./hub.sh run {id}` in terminal - it will execute the code and show the output. You need to have your OPENAI_API_KEY set in your environment (.env file in root directory of your copy of instructor-php repo).
63+
To run a tutorial, you run `./bin/instructor hub run {id}` in terminal - it will execute the code and show the output. You need to have your OPENAI_API_KEY set in your environment (.env file in root directory of your copy of instructor-php repo).
6464

6565
```bash
6666
$ ./bin/instructor hub run {id}
@@ -69,7 +69,7 @@ $ ./bin/instructor hub run {id}
6969

7070
### Running all Cookbooks
7171

72-
This is mostly for testing if cookbooks are executed properly, but you can run `./hub.sh all {id}` to run all the tutorials and examples in the terminal, starting from the one you specify.
72+
This is mostly for testing if cookbooks are executed properly, but you can run `./bin/instructor hub all {id}` to run all the tutorials and examples in the terminal, starting from the one you specify.
7373

7474
```bash
7575
$ ./bin/instructor hub all {id}
File renamed without changes.
File renamed without changes.

docs-build/instructor/http/11-processing-with-middleware.mdx renamed to docs-build/http/11-processing-with-middleware.mdx

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)