Merge branch 'gptscript-ai:main' into main

Author: techmaharaj

.gitignore

@@ -1,3 +1,10 @@
 /bin
 /.idea
 /static/ui
+**/node_modules/
+**/package-lock.json
+**/__pycache__
+/docs/yarn.lock
+/releases
+/checksums.txt
+/.env*

README.md

@@ -10,7 +10,7 @@ calls. With GPTScript you can do just about anything, like [plan a vacation](./e
 [edit a file](./examples/add-go-mod-dep.gpt), [run some SQL](./examples/sqlite-download.gpt), or [build a mongodb/flask app](./examples/hacker-news-headlines.gpt).
 
 | :memo: | We are currently exploring options for interacting with local models using GPTScript. |
-|-|:-|
+| ------ | :------------------------------------------------------------------------------------ |
 
 ```yaml
 # example.gpt
@@ -28,14 +28,18 @@ the result of that.
 
 When done remove the database file and the downloaded content.
 ```
-```
+
+```shell
 $ gptscript ./example.gpt
+```
 
+```
 OUTPUT:
 
 The artist with the most number of albums in the database is Iron Maiden, with a total
 of 21 albums.
 ```
+
 ## Quick Start
 
 ### 1. Install the latest release
@@ -52,6 +56,13 @@ brew install gptscript-ai/tap/gptscript
 curl https://get.gptscript.ai/install.sh | sh
 ```
 
+### Scoop (Windows)
+
+```shell
+scoop bucket add extras # If 'extras' is not already enabled
+scoop install gptscript
+```
+
 #### WinGet (Windows)
 
 ```shell
@@ -70,6 +81,15 @@ Download and install the archive for your platform and architecture from the [re
 export OPENAI_API_KEY="your-api-key"
 ```
 
+Alternatively Azure OpenAI can be utilized
+
+```shell
+export OPENAI_API_KEY="your-api-key"
+export OPENAI_BASE_URL="your-endpiont"
+export OPENAI_API_TYPE="AZURE"
+export OPENAI_AZURE_DEPLOYMENT="your-deployment-name"
+```
+
 #### Windows
 
 ```powershell
@@ -80,16 +100,22 @@ $env:OPENAI = 'your-api-key'
 
 ```shell
 gptscript https://get.gptscript.ai/echo.gpt --input 'Hello, World!'
+```
 
+```
 OUTPUT:
 
 Hello, World!
 ```
+
 The model used by default is `gpt-4-turbo-preview` and you must have access to that model in your OpenAI account.
 
+If using Azure OpenAI, make sure you configure the model to be one of the supported versions with the `--default-model` argument.
+
 ### 4. Extra Credit: Examples and Run Debugging UI
 
 Clone examples and run debugging UI
+
 ```shell
 git clone https://github.com/gptscript-ai/gptscript
 cd gptscript/examples
@@ -100,13 +126,14 @@ gptscript --server
 
 ## How it works
 
-***GPTScript is composed of tools.*** Each tool performs a series of actions similar to a function. Tools have available
+**_GPTScript is composed of tools._** Each tool performs a series of actions similar to a function. Tools have available
 to them other tools that can be invoked similar to a function call. While similar to a function, the tools are
-primarily implemented with a natural language prompt. ***The interaction of the tools is determined by the AI model***,
+primarily implemented with a natural language prompt. **_The interaction of the tools is determined by the AI model_**,
 the model determines if the tool needs to be invoked and what arguments to pass. Tools are intended to be implemented
 with a natural language prompt but can also be implemented with a command or HTTP call.
 
 ### Example
+
 Below are two tool definitions, separated by `---`. The first tool does not require a name or description, but
 every tool after name and description are required. The first tool, has the parameter `tools: bob` meaning that the tool named `bob` is available to be called if needed.
 
@@ -122,14 +149,19 @@ args: question: The question to ask Bob.
 
 When asked how I am doing, respond with "Thanks for asking "${question}", I'm doing great fellow friendly AI tool!"
 ```
+
 Put the above content in a file named `bob.gpt` and run the following command:
+
 ```shell
 $ gptscript bob.gpt
+```
 
+```
 OUTPUT:
 
 Bob said, "Thanks for asking 'How are you doing?', I'm doing great fellow friendly AI tool!"
 ```
+
 Tools can be implemented by invoking a program instead of a natural language prompt. The below
 example is the same as the previous example but implements Bob using python.
 
@@ -156,9 +188,11 @@ or external services.
 ## GPT File Reference
 
 ### Extension
+
 GPTScript files use the `.gpt` extension by convention.
 
 ### File Structure
+
 A GPTScript file has one or more tools in the file. Each tool is separated by three dashes `---` alone on a line.
 
 ```yaml
@@ -191,6 +225,7 @@ Args: arg1: The description of arg1
 
 Tool instructions go here.
 ```
+
 #### Tool Parameters
 
 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):

docs/README-USECASES.md

@@ -0,0 +1,122 @@
+# Use Cases of GPTScript
+
+## Retrieval
+
+Retrieval-Augmented Generation (RAG) leverages a knowledge base outside of the training data before consulting the LLM to generate a response.
+The following GPTScript implements RAG:
+
+```yaml
+name: rag
+description: implements retrieval-augmented generation
+args: prompt: a string
+tools: query
+
+First query the ${prompt} in the knowledge base, then construsts an answer to ${prompt} based on the result of the query.
+
+---
+
+name: query
+description: queries the prompt in the knowledge base
+args: prompt: a string
+
+... (implementation of knowledge base query follows) ...
+```
+
+The idea behind RAG is simple. Its core logic can be implemented in one GPTScript statement: `First query the ${prompt} in the knowledge base, then construsts an answer to ${prompt} based on the result of the query.` The real work of building RAG lies in the tool that queries your knowledge base.
+
+You construct the appropriate query tool based on the type of knowledge base you have.
+
+| Knowledge Base | Query Tool |
+|------|------|
+| A vector database storing common document types such as text, HTML, PDF, and Word | Integrate with LlamaIndex for vector database support [Link to example]|
+| Use the public or private internet to supply up-to-date knowledge | Implement query tools using a search engine, as shown in [`search.gpt`](../examples/search.gpt)|
+| A structured database supporting SQL such as sqlite, MySQL, PostgreSQL, and Oracle DB | Implement query tools using database command line tools such as `sqlite` and `mysql` [Link to example]|
+| An ElasticSearch/OpenSearch database storing logs or other text files | Implement query tools using database command line tools [Link to example]|
+| Other databases such as graph or time series databases | Implement query tools using database command line tools [Link to example]|
+
+## Task Automation
+
+### Planning
+
+Here is a GPTScript that produces a detailed travel itenirary based on inputs from a user: [`travel-agent.gpt`](../examples/travel-agent.gpt)
+
+### Web UI Automation
+
+GPTScript enables the automation of data collection and analysis from websites through seamless interaction with a Chrome web browser. Here's an example to illustrate how it works:
+
+1. Please install the browsing tool and configure it to operate continuously in the background as a service.
+
+```sh
+git clone https://github.com/gptscript-ai/browser
+
+cd browser
+
+npm install
+
+npm run server
+```
+
+2. Let's explore a brief example on how to navigate through the Coachella Festival offerings and retrieve ticketing details
+
+```sh
+# Go to the browser repo you just cloned
+cd browser 
+
+gpscript ./example/coachella-browse.gpt
+```
+
+For additional examples, please explore [here](https://github.com/gptscript-ai/browser?tab=readme-ov-file#examples).
+
+### CLI Automation
+
+Here is a GPTScript that automates Kubernetes operations by driving the `kubectl` command line. [Link to example here]
+
+## Agents and Assistants
+
+Agents and assistants are synonyms. They are software programs that leverage LLM to carry out tasks.
+
+In GPTScript, agents and assistants are implemented using tools. Tools can use other tools. Tools can be implemented using natural language prompts or using traditional programming languages such as Python or JavaScript. You can therefore build arbitrarily complex agents and assistants in GPTScript. Here is an example of an assistant that leverages an HTTP client, MongoDB, and Python code generation to display Hacker News headlines: [`hacker-news-headlines.gpt`](../examples/hacker-news-headlines.gpt)
+
+## Data Analysis
+
+Depending on the context window supported by the LLM, you can either send a large amount of data to the LLM to analyze in one shot or supply data in batches.
+
+### Summarization
+
+Here is a GPTScript that sends a large document in batches to the LLM and produces a summary of the entire document. [hamlet-summarizer](../examples/hamlet-summarizer)
+
+Here is a GPTScript that reads the content of a large SQL database and produces a summary of the entire database. [Link to example here]
+
+### Tagging
+
+Here is a GPTScript that performs sentiment analysis on the input text. [Link to example here]
+
+### CSV Files
+
+Here is a GPTScript that summarizes the content of a CSV file. [Link to example here]
+
+### Understanding Code
+
+Here is a GPTScript that summarizes the the code stored under the current directory: [`describe-code.gpt`](../examples/describe-code.gpt)
+
+## Vision, Image, and Audio
+
+### Vision
+
+Here is an example of a web app that leverages GPTScript to recognize ingredients in a photo and suggest a recipe based on them: [recipe-generator](../examples/recipegenerator).
+
+### Image Generation
+
+Here is a GPTScript that takes a story prompt and generates an illustrated children's book: [story-book.gpt](../examples/story-book)
+
+## Memory Management
+
+LLMs are stateless. That's why GPTScript by default caches LLM invocations. LLM apps need to keep memory outside of the model.
+
+GPTScript provides a means to manage memory that persists across multiple LLM invocations. The relevant information can be extracted and passed into the LLM as part of the context. In addition, LLM can utilize tools to obtain additional data from the memory maintained in GPTScript.
+
+[More details to follow.]
+
+## Chatbots
+
+GPTScript in combination with Rubra UI provide you with a turn-key implementation of chatbots. [More details to follow]

docs/docs/01-overview.md

@@ -27,9 +27,10 @@ the result of that.
 
 When done remove the database file and the downloaded content.
 ```
-```
+```shell
 $ gptscript ./example.gpt
-
+```
+```
 OUTPUT:
 
 The artist with the most number of albums in the database is Iron Maiden, with a total

docs/docs/02-getting-started.md

@@ -32,6 +32,15 @@ Download and install the archive for your platform and architecture from the [re
 export OPENAI_API_KEY="your-api-key"
 ```
 
+Alternatively Azure OpenAI can be utilized
+
+```shell
+export OPENAI_API_KEY="your-api-key"
+export OPENAI_BASE_URL="your-endpiont"
+export OPENAI_API_TYPE="AZURE"
+export OPENAI_AZURE_DEPLOYMENT="your-deployment-name"
+```
+
 #### Windows
 
 ```powershell
@@ -47,11 +56,15 @@ OUTPUT:
 
 Hello, World!
 ```
+
 The model used by default is `gpt-4-turbo-preview` and you must have access to that model in your OpenAI account.
 
+If using Azure OpenAI, make sure you configure the model to be one of the supported versions with the `--default-model` argument.
+
 ### 4. Extra Credit: Examples and Run Debugging UI
 
 Clone examples and run debugging UI
+
 ```shell
 git clone https://github.com/gptscript-ai/gptscript
 cd gptscript/examples

docs/docs/100-tools/03-offerings/02-system.md renamed to docs/docs/100-tools/03-offerings/01-system.md

@@ -14,13 +14,16 @@ referencing the tool's link in your GPTScript. For now, you can follow the steps
 git clone https://github.com/gptscript-ai/image-generation
 ```
 
-2. Run `make bootstrap` to setup the python venv and install the required dependencies.
+2. In the newly cloned repo, run `make bootstrap` to setup the python venv and install the required dependencies. Then activate the virtual environment.
 
 ```shell
 make bootstrap
+source .venv/bin/activate
 ```
 
-3. Reference `<path-to-the-repo>/tool.gpt` in your GPTScript.
+> Note: You can install the python dependencies manually by running `pip install -r requirements.txt` in the root of the cloned repository. This prevents the need to run `make bootstrap` or activate the virtual environment.
+
+3. In the same shell session that your virutal environment is activated, reference `<path-to-the-repo>/tool.gpt` in your GPTScript.
 
 ## Usage
 To use the Image Generation tool, you need to make sure that the OPENAI_API_KEY environment variable is set to your OpenAI API key. You can obtain an API key from the OpenAI platform if you don't already have one.