mirror of
https://github.com/pchuan98/codex.git
synced 2026-07-01 00:31:56 +08:00
Vivian Fang
ea516f9a40
This brings us into better alignment with the JSON schema subset that is supported in <https://developers.openai.com/api/docs/guides/structured-outputs#supported-schemas>, and also allows us to render richer function signatures in code mode (e.g., anyOf{null, OtherObjectType})
60 lines
2.2 KiB
Rust
60 lines
2.2 KiB
Rust
use crate::JsonSchema;
|
|
use crate::ResponsesApiTool;
|
|
use crate::ToolSpec;
|
|
use codex_protocol::models::VIEW_IMAGE_TOOL_NAME;
|
|
use serde_json::Value;
|
|
use serde_json::json;
|
|
use std::collections::BTreeMap;
|
|
|
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
|
pub struct ViewImageToolOptions {
|
|
pub can_request_original_image_detail: bool,
|
|
}
|
|
|
|
pub fn create_view_image_tool(options: ViewImageToolOptions) -> ToolSpec {
|
|
let mut properties = BTreeMap::from([(
|
|
"path".to_string(),
|
|
JsonSchema::string(Some("Local filesystem path to an image file".to_string())),
|
|
)]);
|
|
if options.can_request_original_image_detail {
|
|
properties.insert(
|
|
"detail".to_string(),
|
|
JsonSchema::string(Some(
|
|
"Optional detail override. The only supported value is `original`; omit this field for default resized behavior. Use `original` to preserve the file's original resolution instead of resizing to fit. This is important when high-fidelity image perception or precise localization is needed, especially for CUA agents.".to_string(),
|
|
)),
|
|
);
|
|
}
|
|
|
|
ToolSpec::Function(ResponsesApiTool {
|
|
name: VIEW_IMAGE_TOOL_NAME.to_string(),
|
|
description: "View a local image from the filesystem (only use if given a full filepath by the user, and the image isn't already attached to the thread context within <image ...> tags)."
|
|
.to_string(),
|
|
strict: false,
|
|
defer_loading: None,
|
|
parameters: JsonSchema::object(properties, Some(vec!["path".to_string()]), Some(false.into())),
|
|
output_schema: Some(view_image_output_schema()),
|
|
})
|
|
}
|
|
|
|
fn view_image_output_schema() -> Value {
|
|
json!({
|
|
"type": "object",
|
|
"properties": {
|
|
"image_url": {
|
|
"type": "string",
|
|
"description": "Data URL for the loaded image."
|
|
},
|
|
"detail": {
|
|
"type": ["string", "null"],
|
|
"description": "Image detail hint returned by view_image. Returns `original` when original resolution is preserved, otherwise `null`."
|
|
}
|
|
},
|
|
"required": ["image_url", "detail"],
|
|
"additionalProperties": false
|
|
})
|
|
}
|
|
|
|
#[cfg(test)]
|
|
#[path = "view_image_tests.rs"]
|
|
mod tests;
|