@openai/agents-openai
Version:
The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows.
114 lines • 4.13 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ImageGenerationStatus = exports.CodeInterpreterStatus = exports.FileSearchStatus = exports.WebSearchStatus = void 0;
exports.webSearchTool = webSearchTool;
exports.fileSearchTool = fileSearchTool;
exports.codeInterpreterTool = codeInterpreterTool;
exports.imageGenerationTool = imageGenerationTool;
const zod_1 = require("zod");
// -----------------------------------------------------
// Status enums
// -----------------------------------------------------
exports.WebSearchStatus = zod_1.z
.enum(['in_progress', 'completed', 'searching', 'failed'])
.default('failed');
exports.FileSearchStatus = zod_1.z
.enum(['in_progress', 'completed', 'searching', 'failed', 'incomplete'])
.default('failed');
exports.CodeInterpreterStatus = zod_1.z
.enum(['in_progress', 'completed', 'interpreting'])
.default('in_progress');
exports.ImageGenerationStatus = zod_1.z
.enum(['in_progress', 'completed', 'generating', 'failed'])
.default('failed');
/**
* Adds web search abilities to your agent
* @param options Additional configuration for the web search like specifying the location of your agent
* @returns a web search tool definition
*/
function webSearchTool(options = {}) {
const providerData = {
type: 'web_search',
name: options.name ?? 'web_search',
user_location: options.userLocation,
filters: options.filters?.allowedDomains
? { allowed_domains: options.filters.allowedDomains }
: undefined,
search_context_size: options.searchContextSize ?? 'medium',
};
return {
type: 'hosted_tool',
name: options.name ?? 'web_search',
providerData,
};
}
/**
* Adds file search abilities to your agent
* @param vectorStoreIds The IDs of the vector stores to search.
* @param options Additional configuration for the file search like specifying the maximum number of results to return.
* @returns a file search tool definition
*/
function fileSearchTool(vectorStoreIds, options = {}) {
const vectorIds = Array.isArray(vectorStoreIds)
? vectorStoreIds
: [vectorStoreIds];
const providerData = {
type: 'file_search',
name: options.name ?? 'file_search',
vector_store_ids: vectorIds,
max_num_results: options.maxNumResults,
include_search_results: options.includeSearchResults,
ranking_options: options.rankingOptions,
filters: options.filters,
};
return {
type: 'hosted_tool',
name: options.name ?? 'file_search',
providerData,
};
}
/**
* Adds code interpreter abilities to your agent
* @param options Additional configuration for the code interpreter
* @returns a code interpreter tool definition
*/
function codeInterpreterTool(options = {}) {
const providerData = {
type: 'code_interpreter',
name: options.name ?? 'code_interpreter',
container: options.container ?? { type: 'auto' },
};
return {
type: 'hosted_tool',
name: options.name ?? 'code_interpreter',
providerData,
};
}
/**
* Adds image generation abilities to your agent
* @param options Additional configuration for the image generation
* @returns an image generation tool definition
*/
function imageGenerationTool(options = {}) {
const providerData = {
type: 'image_generation',
name: options.name ?? 'image_generation',
background: options.background,
input_fidelity: options.inputFidelity,
input_image_mask: options.inputImageMask,
model: options.model,
moderation: options.moderation,
output_compression: options.outputCompression,
output_format: options.outputFormat,
partial_images: options.partialImages,
quality: options.quality,
size: options.size,
};
return {
type: 'hosted_tool',
name: options.name ?? 'image_generation',
providerData,
};
}
// HostedMCPTool exists in agents-core package
//# sourceMappingURL=tools.js.map