Download the PHP package shipfastlabs/toolkit-tavily without Composer
On this page you can find all versions of the php package shipfastlabs/toolkit-tavily. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package toolkit-tavily
shipfastlabs/toolkit-tavily
Tavily tools for the Laravel AI SDK - Search, Extract, Crawl, and Map
Part of the shipfastlabs/toolkit catalog of reusable AI tools for the Laravel AI SDK.
Installation
Usage
Register every Tavily tool at once with the Tavily helper:
Or add individual tools to an agent's tools():
Tools
TavilySearch
Search the web for real-time information.
| Parameter | Type | Required | Description |
|---|---|---|---|
query |
string | yes | The search query to look up on the web. |
max_results |
integer | no | Maximum number of search results to return (1-10). Defaults to 5. |
search_depth |
string | no | "basic" for fast results or "advanced" for comprehensive. Defaults to "basic". |
include_answer |
boolean | no | Whether to include a concise AI-generated answer. Defaults to false. |
TavilyExtract
Extract clean, structured content from URLs.
| Parameter | Type | Required | Description |
|---|---|---|---|
urls |
string | yes | A single URL or comma-separated URLs to extract content from. |
query |
string | no | Optional query to rerank extracted chunks by relevance. |
extract_depth |
string | no | "basic" or "advanced". Defaults to "basic". |
format |
string | no | "markdown" or "text". Defaults to "markdown". |
include_images |
boolean | no | Whether to include images extracted from URLs. Defaults to false. |
TavilyCrawl
Intelligently crawl a website and extract content.
| Parameter | Type | Required | Description |
|---|---|---|---|
url |
string | yes | The root URL to begin the crawl from. |
instructions |
string | no | Optional natural language instructions for the crawler. |
max_depth |
integer | no | Maximum crawl depth (1-5). Defaults to 1. |
max_breadth |
integer | no | Maximum links to follow per page (1-500). Defaults to 20. |
limit |
integer | no | Total number of links to process. Defaults to 50. |
extract_depth |
string | no | "basic" or "advanced". Defaults to "basic". |
allow_external |
boolean | no | Whether to allow crawling external domains. Defaults to false. |
TavilyMap
Discover and map a website's structure.
| Parameter | Type | Required | Description |
|---|---|---|---|
url |
string | yes | The root URL to begin the mapping from. |
instructions |
string | no | Optional natural language instructions for the crawler. |
max_depth |
integer | no | Maximum map depth (1-5). Defaults to 1. |
max_breadth |
integer | no | Maximum links to follow per page (1-500). Defaults to 20. |
limit |
integer | no | Total number of links to process. Defaults to 50. |
allow_external |
boolean | no | Whether to allow crawling external domains. Defaults to false. |
Provider setup
All tools read their API credentials from Laravel's services config and their optional defaults from the ai config.
1. Add the Tavily service to config/services.php
2. Add toolkit defaults to config/ai.php
3. Add environment variables to .env
| Config key | Env var | Default | Description |
|---|---|---|---|
services.tavily.key |
TAVILY_API_KEY |
- | Required. Your Tavily API key. |
ai.toolkit.tavily.search.max_results |
TAVILY_SEARCH_MAX_RESULTS |
5 |
Default search results (1-10). |
ai.toolkit.tavily.search.search_depth |
TAVILY_SEARCH_DEPTH |
"basic" |
"basic" or "advanced". |
ai.toolkit.tavily.search.include_answer |
TAVILY_SEARCH_INCLUDE_ANSWER |
false |
Default for AI-generated answer. |
ai.toolkit.tavily.extract.extract_depth |
TAVILY_EXTRACT_DEPTH |
"basic" |
"basic" or "advanced". |
ai.toolkit.tavily.extract.format |
TAVILY_EXTRACT_FORMAT |
"markdown" |
"markdown" or "text". |
ai.toolkit.tavily.crawl.max_depth |
TAVILY_CRAWL_MAX_DEPTH |
1 |
Max crawl depth (1-5). |
ai.toolkit.tavily.crawl.max_breadth |
TAVILY_CRAWL_MAX_BREADTH |
20 |
Max links per page (1-500). |
ai.toolkit.tavily.crawl.limit |
TAVILY_CRAWL_LIMIT |
50 |
Total links to process. |
ai.toolkit.tavily.crawl.extract_depth |
TAVILY_CRAWL_EXTRACT_DEPTH |
"basic" |
"basic" or "advanced". |
ai.toolkit.tavily.map.max_depth |
TAVILY_MAP_MAX_DEPTH |
1 |
Max map depth (1-5). |
ai.toolkit.tavily.map.max_breadth |
TAVILY_MAP_MAX_BREADTH |
20 |
Max links per page (1-500). |
ai.toolkit.tavily.map.limit |
TAVILY_MAP_LIMIT |
50 |
Total links to process. |
Safety
- All tools validate required inputs before calling the API.
- Numeric parameters are clamped to their valid ranges.
- API errors are caught and returned as friendly string messages.
- Requires a valid Tavily API key.
Tavily API
These tools use the Tavily API. Tavily offers a generous free tier with 1,000 API credits per month.
Full API reference:
All versions of toolkit-tavily with dependencies
PHP Build Version
Package Version
Requires
php Version
^8.4.0
illuminate/contracts Version ^12.0|^13.0
illuminate/support Version ^12.0|^13.0
laravel/ai Version ^0.7|^0.10|^0.11|^1.0
illuminate/contracts Version ^12.0|^13.0
illuminate/support Version ^12.0|^13.0
laravel/ai Version ^0.7|^0.10|^0.11|^1.0
The package shipfastlabs/toolkit-tavily contains the following files
Loading the files please wait ...