Skip to content

add (docs): add some newer fields to the gpt file reference #683

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

Merged
merged 3 commits into from
Aug 1, 2024
Merged

add (docs): add some newer fields to the gpt file reference #683

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ae9e22
add (docs): add some newer fields to the gpt file reference
iwilltry42 Jul 31, 2024
7b76699
chore (docs): some fixes and enhancements
iwilltry42 Jul 31, 2024
1697c32
Update docs/docs/02-examples/04-local-files.md
iwilltry42 Jul 31, 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
Next Next commit
add (docs): add some newer fields to the gpt file reference
  • Loading branch information
@iwilltry42
iwilltry42 committed Jul 31, 2024
commit 8ae9e2225bb71b30512d73cb253214ed17a62bc0
34 changes: 19 additions & 15 deletions docs/docs/03-tools/07-gpt-file-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,25 @@ Tool instructions go here.

Tool parameters are key-value pairs defined at the beginning of a tool block, before any instructional text. They are specified in the format `key: value`. The parser recognizes the following keys (case-insensitive and spaces are ignored):

| Key | Description |
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `Name` | The name of the tool. |
| `Model Name` | The LLM model to use, by default it uses "gpt-4-turbo". |
| `Global Model Name`| The LLM model to use for all the tools. |
| `Description` | The description of the tool. It is important that this properly describes the tool's purpose as the description is used by the LLM. |
| `Internal Prompt` | Setting this to `false` will disable the built-in system prompt for this tool. |
| `Tools` | A comma-separated list of tools that are available to be called by this tool. |
| `Global Tools` | A comma-separated list of tools that are available to be called by all tools. |
| `Credentials` | A comma-separated list of credential tools to run before the main tool. |
| `Args` | Arguments for the tool. Each argument is defined in the format `arg-name: description`. |
| `Max Tokens` | Set to a number if you wish to limit the maximum number of tokens that can be generated by the LLM. |
| `JSON Response` | Setting to `true` will cause the LLM to respond in a JSON format. If you set true you must also include instructions in the tool. |
| `Temperature` | A floating-point number representing the temperature parameter. By default, the temperature is 0. Set to a higher number for more creativity. |
| `Chat` | Setting it to `true` will enable an interactive chat session for the tool. |
| Key | Description |
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| `Name` | The name of the tool. |
| `Model Name` | The LLM model to use, by default it uses "gpt-4-turbo". |
| `Global Model Name` | The LLM model to use for all the tools. |
| `Description` | The description of the tool. It is important that this properly describes the tool's purpose as the description is used by the LLM. |
| `Internal Prompt` | Setting this to `false` will disable the built-in system prompt for this tool. |
| `Tools` | A comma-separated list of tools that are available to be called by this tool. |
| `Global Tools` | A comma-separated list of tools that are available to be called by all tools. |
| `Parameter` / `Args` | Arguments for the tool. Each argument is defined in the format `arg-name: description`. |
| `Max Tokens` | Set to a number if you wish to limit the maximum number of tokens that can be generated by the LLM. |
| `JSON Response` | Setting to `true` will cause the LLM to respond in a JSON format. If you set true you must also include instructions in the tool. |
| `Temperature` | A floating-point number representing the temperature parameter. By default, the temperature is 0. Set to a higher number for more creativity. |
| `Chat` | Setting it to `true` will enable an interactive chat session for the tool. |
| `Credential` | Credential tool to call to set credentials as environment variables before doing anything else. One per line. |
| `Agents` | A comma-separated list of agents that are available to the tool. |
| `Share Tools` | A comma-separated list of tools that are shared by the tool. |
| `Context` | A comma-separated list of context tools available to the tool |


Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's more here, but I'm not sure if we should put everything (e.g. temperature and max_tokens) here



Expand Down