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.

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

new line typo fixed in readme #15

Merged
merged 1 commit into from
Jun 27, 2024
Merged
Changes from all commits
Commits
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
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ OPENROUTER_DEFAULT_MODEL=default_model
## ⚡ Quick Usage Guide
This package is designed to be **flexible**, but for an **easy quick start**, follow the steps below:
- Create a file named `functions.yml` under a directory of your choice. Modify config file accordingly for `functions_yml_path`.
<br/>
(Check [Generate Function List](#generate-function-list) for further details).
```php
'functions_yml_path' => __DIR__ . '/../resources/functions.yml', // functions.yml is located under resources folder in this example.
Expand Down Expand Up @@ -192,7 +191,6 @@ LaravelPromptAlchemist::generateFunctionList($class, $functions, $fileName);
```

- Create yml file for **function payload schema** and modify `function_payload_schema_path` in **config** accordingly.
<br/>
(Check [Function Payload Schema](#function-payload-schema) for further details).
<br/>

Expand Down Expand Up @@ -241,7 +239,6 @@ $response = LaravelOpenRouter::chatRequest($chatData);
```

- **Validate** the response retrieved from **OpenRouter**.
<br/>
(Check [Validate Function Signature](#validate-function-signature) for further details).
<br/>

Expand Down Expand Up @@ -272,7 +269,6 @@ $isValid = LaravelOpenRouter::validateFunctionSignature($llmReturnedFunctionData
```

- And finally, call **functions returned from the LLM** which are necessary for answering the **prompt** (Since **function signature** is **validated**, it is now **safe** to call **LLM returned functions**).
<br/>
(Check [Call Function (Actual Function Call)](#call-function-actual-function-call) for further details).
<br/>

Expand Down Expand Up @@ -329,7 +325,6 @@ FunctionResultData([
Where `function_name` is the **name of the function called** as the name suggested, and `result` is the **function call result** can be anything (void, array, object, bool etc. whatever your function returns to.)

- Optionally, you can also send **function results** to LLM so that regarding `function_results_schema`, it will return the answer.
<br/>
(Check [Prepare Function Results Payload](#prepare-function-results-payload) for further details)
```php
$prompt = 'Can tell me Mr. Boolean Bob credit score?';
Expand Down
Loading