This repo contains search tools for GPTScript. We currently support Bing (web and image), Brave (web and image), DuckDuckGo (web only), and Google (web and image).
Web search output is in the following format:
Title: the title of the web page
URL: the link to the web page
Description: a short snippet from the web page
Image search output is in the following format:
Title: the title of the image
Source: the link to the web page where the image came from
Image URL: the link to the image
For usage examples with GPTScript, see the examples directory.
You are responsible for ensuring that your use of these search APIs with GPTScript does not violate the terms of service of the respective search engines.
# Build the binary
make build
# Set up the environment
export OPENAI_API_KEY=your-api-key
# Run one of the examples
gptscript --cache=false ./examples/duckduckgo/coffee-grinders.gptAll tools are currently implemented in the tool.gpt file.
The bing and bing-image tools return search results from the Bing Web Search API.
The environment variable GPTSCRIPT_BING_SEARCH_TOKEN must be set to your API key in order for it to work.
The brave and brave-image tools return search results from the Brave Search API.
The environment variable GPTSCRIPT_BRAVE_SEARCH_TOKEN must be set to your API key in order for it to work.
The duckduckgo tool returns search results from the DuckDuckGo HTML-only Site.
No API key is required to use this tool.
By default, this tool will make an HTTP request to DuckDuckGo and parse the results. If you do this enough times, it will start to get rate limited.
Rate limits can be more easily avoided by using Google Chrome in headless mode. The tool will do this if the GPTSCRIPT_USE_CHROME environment variable is set to true.
The google and google-image tools return search results from the Google Custom Search JSON API.
The environment variable GPTSCRIPT_GOOGLE_SEARCH_TOKEN must be set to your API key, and GPTSCRIPT_GOOGLE_SEARCH_ENGINE_ID must be set to your search engine ID in order for it to work.