🚀 Socket Launch Week Day 5:Introducing Repository Access Permissions and Custom Roles.Learn more →
Sign In

@ai-sdk/gateway

Package Overview
Dependencies
Maintainers
3
Versions
542
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ai-sdk/gateway - npm Package Compare versions

Comparing version
3.0.137
 to
3.0.138
+352
src/tool/exa-search.ts
import {
createProviderToolFactoryWithOutputSchema,
lazySchema,
zodSchema,
} from '@ai-sdk/provider-utils';
import { z } from 'zod';
export type ExaSearchType = 'auto' | 'fast' | 'instant';
export type ExaSearchCategory =
| 'company'
| 'people'
| 'research paper'
| 'news'
| 'personal site'
| 'financial report';
export type ExaTextSection =
| 'header'
| 'navigation'
| 'banner'
| 'body'
| 'sidebar'
| 'footer'
| 'metadata';
export interface ExaSearchTextConfig {
maxCharacters?: number;
includeHtmlTags?: boolean;
verbosity?: 'compact' | 'standard' | 'full';
includeSections?: ExaTextSection[];
excludeSections?: ExaTextSection[];
}
export interface ExaSearchHighlightsConfig {
query?: string;
maxCharacters?: number;
}
export interface ExaSearchExtrasConfig {
links?: number;
imageLinks?: number;
}
export interface ExaSearchContentsConfig {
text?: boolean | ExaSearchTextConfig;
highlights?: boolean | ExaSearchHighlightsConfig;
maxAgeHours?: number;
livecrawlTimeout?: number;
subpages?: number;
subpageTarget?: string | string[];
extras?: ExaSearchExtrasConfig;
}
export interface ExaSearchConfig {
/**
* Default search method. Exa defaults to auto when omitted.
*/
type?: ExaSearchType;
/**
* Default maximum number of results to return (1-100, default: 10).
*/
numResults?: number;
/**
* Default category filter for result types.
*/
category?: ExaSearchCategory;
/**
* Default two-letter ISO country code for location-aware search.
*/
userLocation?: string;
/**
* Default domains to include or exclude.
*/
includeDomains?: string[];
excludeDomains?: string[];
/**
* Default published date filters in ISO 8601 format.
*/
startPublishedDate?: string;
endPublishedDate?: string;
/**
* Default content extraction controls.
*/
contents?: ExaSearchContentsConfig;
}
export interface ExaSearchResult {
title: string;
url: string;
id: string;
publishedDate?: string | null;
author?: string | null;
image?: string | null;
favicon?: string | null;
text?: string;
highlights?: string[];
highlightScores?: number[];
summary?: string;
subpages?: ExaSearchResult[];
extras?: {
links?: string[];
imageLinks?: string[];
};
}
export interface ExaSearchResponse {
requestId: string;
searchType?: string;
resolvedSearchType?: string;
results: ExaSearchResult[];
costDollars?: {
total?: number;
search?: Record<string, number>;
};
}
export interface ExaSearchError {
error:
| 'api_error'
| 'rate_limit'
| 'timeout'
| 'invalid_input'
| 'configuration_error'
| 'execution_error'
| 'unknown';
statusCode?: number;
message: string;
}
export interface ExaSearchInput {
query: string;
type?: ExaSearchType;
num_results?: number;
category?: ExaSearchCategory;
user_location?: string;
include_domains?: string[];
exclude_domains?: string[];
start_published_date?: string;
end_published_date?: string;
contents?: {
text?:
| boolean
| {
max_characters?: number;
include_html_tags?: boolean;
verbosity?: 'compact' | 'standard' | 'full';
include_sections?: ExaTextSection[];
exclude_sections?: ExaTextSection[];
};
highlights?:
| boolean
| {
query?: string;
max_characters?: number;
};
max_age_hours?: number;
livecrawl_timeout?: number;
subpages?: number;
subpage_target?: string | string[];
extras?: {
links?: number;
image_links?: number;
};
};
}
export type ExaSearchOutput = ExaSearchResponse | ExaSearchError;
const exaSearchInputSchema = lazySchema(() =>
zodSchema(
z.object({
query: z
.string()
.describe('Natural-language web search query. This is required.'),
type: z
.enum(['auto', 'fast', 'instant'])
.optional()
.describe(
'Search method. Use auto for the default balance of speed and quality.',
),
num_results: z
.number()
.optional()
.describe('Maximum number of results to return (1-100, default: 10).'),
category: z
.enum([
'company',
'people',
'research paper',
'news',
'personal site',
'financial report',
])
.optional()
.describe('Optional content category to focus results.'),
user_location: z
.string()
.optional()
.describe("Two-letter ISO country code such as 'US'."),
include_domains: z
.array(z.string())
.optional()
.describe('Only return results from these domains.'),
exclude_domains: z
.array(z.string())
.optional()
.describe('Exclude results from these domains.'),
start_published_date: z
.string()
.optional()
.describe('Only return links published after this ISO 8601 date.'),
end_published_date: z
.string()
.optional()
.describe('Only return links published before this ISO 8601 date.'),
contents: z
.object({
text: z
.union([
z.boolean(),
z.object({
max_characters: z.number().optional(),
include_html_tags: z.boolean().optional(),
verbosity: z.enum(['compact', 'standard', 'full']).optional(),
include_sections: z
.array(
z.enum([
'header',
'navigation',
'banner',
'body',
'sidebar',
'footer',
'metadata',
]),
)
.optional(),
exclude_sections: z
.array(
z.enum([
'header',
'navigation',
'banner',
'body',
'sidebar',
'footer',
'metadata',
]),
)
.optional(),
}),
])
.optional(),
highlights: z
.union([
z.boolean(),
z.object({
query: z.string().optional(),
max_characters: z.number().optional(),
}),
])
.optional(),
max_age_hours: z.number().optional(),
livecrawl_timeout: z.number().optional(),
subpages: z.number().optional(),
subpage_target: z.union([z.string(), z.array(z.string())]).optional(),
extras: z
.object({
links: z.number().optional(),
image_links: z.number().optional(),
})
.optional(),
})
.optional()
.describe('Controls extracted page content and freshness.'),
}),
),
);
const exaSearchOutputSchema = lazySchema(() =>
zodSchema(
z.union([
z.object({
requestId: z.string(),
searchType: z.string().optional(),
resolvedSearchType: z.string().optional(),
results: z.array(
z.object({
title: z.string(),
url: z.string(),
id: z.string(),
publishedDate: z.string().nullable().optional(),
author: z.string().nullable().optional(),
image: z.string().nullable().optional(),
favicon: z.string().nullable().optional(),
text: z.string().optional(),
highlights: z.array(z.string()).optional(),
highlightScores: z.array(z.number()).optional(),
summary: z.string().optional(),
subpages: z.array(z.any()).optional(),
extras: z
.object({
links: z.array(z.string()).optional(),
imageLinks: z.array(z.string()).optional(),
})
.optional(),
}),
),
costDollars: z
.object({
total: z.number().optional(),
search: z.record(z.number()).optional(),
})
.optional(),
}),
z.object({
error: z.enum([
'api_error',
'rate_limit',
'timeout',
'invalid_input',
'configuration_error',
'execution_error',
'unknown',
]),
statusCode: z.number().optional(),
message: z.string(),
}),
]),
),
);
export const exaSearchToolFactory = createProviderToolFactoryWithOutputSchema<
ExaSearchInput,
ExaSearchOutput,
ExaSearchConfig
>({
id: 'gateway.exa_search',
inputSchema: exaSearchInputSchema,
outputSchema: exaSearchOutputSchema,
});
export const exaSearch = (
config: ExaSearchConfig = {},
): ReturnType<typeof exaSearchToolFactory> => exaSearchToolFactory(config);
+10
-0
CHANGELOG.md
# @ai-sdk/gateway
## 3.0.138
### Patch Changes
- fb601aa: feat (provider/gateway): add Exa search tool support
- f19334d: feat (video): add first-class `generateAudio` call option
- Updated dependencies [f19334d]
- @ai-sdk/provider@3.0.12
- @ai-sdk/provider-utils@4.0.32
## 3.0.137

@@ -4,0 +14,0 @@ 

+135
-0
dist/index.d.mts

@@ -439,2 +439,129 @@ import { LanguageModelV3, ProviderV3, EmbeddingModelV3, ImageModelV3, Experimental_VideoModelV3, RerankingModelV3, SpeechModelV3, TranscriptionModelV3, TypeValidationError } from '@ai-sdk/provider';

type ExaSearchType = 'auto' | 'fast' | 'instant';
type ExaSearchCategory = 'company' | 'people' | 'research paper' | 'news' | 'personal site' | 'financial report';
type ExaTextSection = 'header' | 'navigation' | 'banner' | 'body' | 'sidebar' | 'footer' | 'metadata';
interface ExaSearchTextConfig {
maxCharacters?: number;
includeHtmlTags?: boolean;
verbosity?: 'compact' | 'standard' | 'full';
includeSections?: ExaTextSection[];
excludeSections?: ExaTextSection[];
}
interface ExaSearchHighlightsConfig {
query?: string;
maxCharacters?: number;
}
interface ExaSearchExtrasConfig {
links?: number;
imageLinks?: number;
}
interface ExaSearchContentsConfig {
text?: boolean | ExaSearchTextConfig;
highlights?: boolean | ExaSearchHighlightsConfig;
maxAgeHours?: number;
livecrawlTimeout?: number;
subpages?: number;
subpageTarget?: string | string[];
extras?: ExaSearchExtrasConfig;
}
interface ExaSearchConfig {
/**
* Default search method. Exa defaults to auto when omitted.
*/
type?: ExaSearchType;
/**
* Default maximum number of results to return (1-100, default: 10).
*/
numResults?: number;
/**
* Default category filter for result types.
*/
category?: ExaSearchCategory;
/**
* Default two-letter ISO country code for location-aware search.
*/
userLocation?: string;
/**
* Default domains to include or exclude.
*/
includeDomains?: string[];
excludeDomains?: string[];
/**
* Default published date filters in ISO 8601 format.
*/
startPublishedDate?: string;
endPublishedDate?: string;
/**
* Default content extraction controls.
*/
contents?: ExaSearchContentsConfig;
}
interface ExaSearchResult {
title: string;
url: string;
id: string;
publishedDate?: string | null;
author?: string | null;
image?: string | null;
favicon?: string | null;
text?: string;
highlights?: string[];
highlightScores?: number[];
summary?: string;
subpages?: ExaSearchResult[];
extras?: {
links?: string[];
imageLinks?: string[];
};
}
interface ExaSearchResponse {
requestId: string;
searchType?: string;
resolvedSearchType?: string;
results: ExaSearchResult[];
costDollars?: {
total?: number;
search?: Record<string, number>;
};
}
interface ExaSearchError {
error: 'api_error' | 'rate_limit' | 'timeout' | 'invalid_input' | 'configuration_error' | 'execution_error' | 'unknown';
statusCode?: number;
message: string;
}
interface ExaSearchInput {
query: string;
type?: ExaSearchType;
num_results?: number;
category?: ExaSearchCategory;
user_location?: string;
include_domains?: string[];
exclude_domains?: string[];
start_published_date?: string;
end_published_date?: string;
contents?: {
text?: boolean | {
max_characters?: number;
include_html_tags?: boolean;
verbosity?: 'compact' | 'standard' | 'full';
include_sections?: ExaTextSection[];
exclude_sections?: ExaTextSection[];
};
highlights?: boolean | {
query?: string;
max_characters?: number;
};
max_age_hours?: number;
livecrawl_timeout?: number;
subpages?: number;
subpage_target?: string | string[];
extras?: {
links?: number;
image_links?: number;
};
};
}
type ExaSearchOutput = ExaSearchResponse | ExaSearchError;
declare const exaSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<ExaSearchInput, ExaSearchOutput, ExaSearchConfig>;
/**

@@ -445,2 +572,10 @@ * Gateway-specific provider-defined tools.

/**
* Search the web using Exa for current information and token-efficient
* excerpts optimized for agent workflows.
*
* Supports search type, category, domain, date, location, and content
* extraction controls.
*/
exaSearch: (config?: ExaSearchConfig) => ReturnType<typeof exaSearchToolFactory>;
/**
* Search the web using Parallel AI's Search API for LLM-optimized excerpts.

@@ -447,0 +582,0 @@ *

+135
-0
dist/index.d.ts

@@ -439,2 +439,129 @@ import { LanguageModelV3, ProviderV3, EmbeddingModelV3, ImageModelV3, Experimental_VideoModelV3, RerankingModelV3, SpeechModelV3, TranscriptionModelV3, TypeValidationError } from '@ai-sdk/provider';

type ExaSearchType = 'auto' | 'fast' | 'instant';
type ExaSearchCategory = 'company' | 'people' | 'research paper' | 'news' | 'personal site' | 'financial report';
type ExaTextSection = 'header' | 'navigation' | 'banner' | 'body' | 'sidebar' | 'footer' | 'metadata';
interface ExaSearchTextConfig {
maxCharacters?: number;
includeHtmlTags?: boolean;
verbosity?: 'compact' | 'standard' | 'full';
includeSections?: ExaTextSection[];
excludeSections?: ExaTextSection[];
}
interface ExaSearchHighlightsConfig {
query?: string;
maxCharacters?: number;
}
interface ExaSearchExtrasConfig {
links?: number;
imageLinks?: number;
}
interface ExaSearchContentsConfig {
text?: boolean | ExaSearchTextConfig;
highlights?: boolean | ExaSearchHighlightsConfig;
maxAgeHours?: number;
livecrawlTimeout?: number;
subpages?: number;
subpageTarget?: string | string[];
extras?: ExaSearchExtrasConfig;
}
interface ExaSearchConfig {
/**
* Default search method. Exa defaults to auto when omitted.
*/
type?: ExaSearchType;
/**
* Default maximum number of results to return (1-100, default: 10).
*/
numResults?: number;
/**
* Default category filter for result types.
*/
category?: ExaSearchCategory;
/**
* Default two-letter ISO country code for location-aware search.
*/
userLocation?: string;
/**
* Default domains to include or exclude.
*/
includeDomains?: string[];
excludeDomains?: string[];
/**
* Default published date filters in ISO 8601 format.
*/
startPublishedDate?: string;
endPublishedDate?: string;
/**
* Default content extraction controls.
*/
contents?: ExaSearchContentsConfig;
}
interface ExaSearchResult {
title: string;
url: string;
id: string;
publishedDate?: string | null;
author?: string | null;
image?: string | null;
favicon?: string | null;
text?: string;
highlights?: string[];
highlightScores?: number[];
summary?: string;
subpages?: ExaSearchResult[];
extras?: {
links?: string[];
imageLinks?: string[];
};
}
interface ExaSearchResponse {
requestId: string;
searchType?: string;
resolvedSearchType?: string;
results: ExaSearchResult[];
costDollars?: {
total?: number;
search?: Record<string, number>;
};
}
interface ExaSearchError {
error: 'api_error' | 'rate_limit' | 'timeout' | 'invalid_input' | 'configuration_error' | 'execution_error' | 'unknown';
statusCode?: number;
message: string;
}
interface ExaSearchInput {
query: string;
type?: ExaSearchType;
num_results?: number;
category?: ExaSearchCategory;
user_location?: string;
include_domains?: string[];
exclude_domains?: string[];
start_published_date?: string;
end_published_date?: string;
contents?: {
text?: boolean | {
max_characters?: number;
include_html_tags?: boolean;
verbosity?: 'compact' | 'standard' | 'full';
include_sections?: ExaTextSection[];
exclude_sections?: ExaTextSection[];
};
highlights?: boolean | {
query?: string;
max_characters?: number;
};
max_age_hours?: number;
livecrawl_timeout?: number;
subpages?: number;
subpage_target?: string | string[];
extras?: {
links?: number;
image_links?: number;
};
};
}
type ExaSearchOutput = ExaSearchResponse | ExaSearchError;
declare const exaSearchToolFactory: _ai_sdk_provider_utils.ProviderToolFactoryWithOutputSchema<ExaSearchInput, ExaSearchOutput, ExaSearchConfig>;
/**

@@ -445,2 +572,10 @@ * Gateway-specific provider-defined tools.

/**
* Search the web using Exa for current information and token-efficient
* excerpts optimized for agent workflows.
*
* Supports search type, category, domain, date, location, and content
* extraction controls.
*/
exaSearch: (config?: ExaSearchConfig) => ReturnType<typeof exaSearchToolFactory>;
/**
* Search the web using Parallel AI's Search API for LLM-optimized excerpts.

@@ -447,0 +582,0 @@ *

+3
-3
package.json
{
"name": "@ai-sdk/gateway",
"private": false,
"version": "3.0.137",
"version": "3.0.138",
"license": "Apache-2.0",

@@ -34,4 +34,4 @@ "sideEffects": false,

"@vercel/oidc": "3.2.0",
"@ai-sdk/provider": "3.0.11",
"@ai-sdk/provider-utils": "4.0.31"
"@ai-sdk/provider": "3.0.12",
"@ai-sdk/provider-utils": "4.0.32"
},

@@ -38,0 +38,0 @@ "devDependencies": {

+10
-0
src/gateway-tools.ts

@@ -0,1 +1,2 @@

import { exaSearch } from './tool/exa-search';
import { parallelSearch } from './tool/parallel-search';

@@ -9,2 +10,11 @@ import { perplexitySearch } from './tool/perplexity-search';

/**
* Search the web using Exa for current information and token-efficient
* excerpts optimized for agent workflows.
*
* Supports search type, category, domain, date, location, and content
* extraction controls.
*/
exaSearch,
/**
* Search the web using Parallel AI's Search API for LLM-optimized excerpts.

@@ -11,0 +21,0 @@ *

+2
-0
src/gateway-video-model.ts

@@ -49,2 +49,3 @@ import {

seed,
generateAudio,
image,

@@ -83,2 +84,3 @@ providerOptions,

...(seed && { seed }),
...(generateAudio !== undefined && { generateAudio }),
...(providerOptions && { providerOptions }),

@@ -85,0 +87,0 @@ ...(image && { image: maybeEncodeVideoFile(image) }),

dist/index.js

Sorry, the diff of this file is too big to display

dist/index.js.map

Sorry, the diff of this file is too big to display

dist/index.mjs

Sorry, the diff of this file is too big to display

dist/index.mjs.map

Sorry, the diff of this file is too big to display

docs/00-ai-gateway.mdx

Sorry, the diff of this file is not supported yet