mirror of
https://github.com/openai/codex.git
synced 2026-10-27 16:02:59 +00:00
Winston Howes
07d631875e
## Summary - Rename the hosted web-search wire field to the canonical `indexed_web_access` spelling. - Preserve existing indexed-search behavior. ## Rollout Merge and release only after server support for `indexed_web_access` is fully deployed. ## Testing - `just fmt` - `just test -p codex-tools web_search_tool_spec_serializes_expected_wire_shape` - Blocking CI passed, including indexed web-search integration coverage.
57 lines
1.9 KiB
Rust
57 lines
1.9 KiB
Rust
use codex_protocol::config_types::WebSearchConfig;
|
|
use codex_protocol::config_types::WebSearchMode;
|
|
use codex_protocol::openai_models::WebSearchToolType;
|
|
use codex_tools::ToolSpec;
|
|
|
|
const WEB_SEARCH_TEXT_AND_IMAGE_CONTENT_TYPES: [&str; 2] = ["text", "image"];
|
|
|
|
pub struct WebSearchToolOptions<'a> {
|
|
pub web_search_mode: Option<WebSearchMode>,
|
|
pub web_search_config: Option<&'a WebSearchConfig>,
|
|
pub web_search_tool_type: WebSearchToolType,
|
|
}
|
|
|
|
pub fn create_image_generation_tool(output_format: &str) -> ToolSpec {
|
|
ToolSpec::ImageGeneration {
|
|
output_format: output_format.to_string(),
|
|
}
|
|
}
|
|
|
|
pub fn create_web_search_tool(options: WebSearchToolOptions<'_>) -> Option<ToolSpec> {
|
|
let (external_web_access, indexed_web_access) = match options.web_search_mode {
|
|
Some(WebSearchMode::Cached) => (false, None),
|
|
Some(WebSearchMode::Indexed) => (true, Some(true)),
|
|
Some(WebSearchMode::Live) => (true, None),
|
|
Some(WebSearchMode::Disabled) | None => return None,
|
|
};
|
|
|
|
let search_content_types = match options.web_search_tool_type {
|
|
WebSearchToolType::Text => None,
|
|
WebSearchToolType::TextAndImage => Some(
|
|
WEB_SEARCH_TEXT_AND_IMAGE_CONTENT_TYPES
|
|
.into_iter()
|
|
.map(str::to_string)
|
|
.collect(),
|
|
),
|
|
};
|
|
|
|
Some(ToolSpec::WebSearch {
|
|
external_web_access: Some(external_web_access),
|
|
indexed_web_access,
|
|
filters: options
|
|
.web_search_config
|
|
.and_then(|config| config.filters.clone().map(Into::into)),
|
|
user_location: options
|
|
.web_search_config
|
|
.and_then(|config| config.user_location.clone().map(Into::into)),
|
|
search_context_size: options
|
|
.web_search_config
|
|
.and_then(|config| config.search_context_size),
|
|
search_content_types,
|
|
})
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[path = "hosted_spec_tests.rs"]
|
|
mod tests;
|