Skip to content

Commit cde67b2

Browse files
committed
Update README with social preview and description refinements; refactor: rename web_search_preview tool to web_search.
1 parent 2e78826 commit cde67b2

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Compendium Scribe
22

3-
[![Build Status](https://github.com/btfranklin/compendiumscribe/actions/workflows/python-package.yml/badge.svg)](https://github.com/btfranklin/compendiumscribe/actions/workflows/python-package.yml)
4-
[![Supports Python versions 3.12+](https://img.shields.io/pypi/pyversions/compendiumscribe.svg)](https://pypi.python.org/pypi/compendiumscribe)
3+
![Social Preview](.github/social%20preview/compendiumscribe_social_preview.jpg)
54

6-
Compendium Scribe is a Click-driven command line tool and library that uses OpenAI's **deep research** models to assemble a comprehensive research compendium for any topic. The workflow combines optional prompt refinement (powered by `gpt-4.1`), an `o3-deep-research` call with web search tooling, and deterministic post-processing. It produces human-readable Markdown by default, backed by a rich XML data model that can also be exported.
5+
Compendium Scribe is a Click-driven command line tool and library that uses OpenAI's **deep research** models to assemble a comprehensive research compendium for any topic. The workflow combines optional prompt refinement, a "deep research" call with web search tooling, and deterministic post-processing. It produces human-readable Markdown by default, backed by a rich XML data model that can also be exported.
76

87
---
98

src/compendiumscribe/research/execution/core.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ def execute_deep_research(
2020
"""Submit a deep research request and return the completed response."""
2121
tools: list[dict[str, Any]] = []
2222
if config.use_web_search:
23-
tools.append({"type": "web_search_preview"})
23+
tools.append({"type": "web_search"})
2424
if config.enable_code_interpreter:
2525
tools.append(
2626
{"type": "code_interpreter", "container": {"type": "auto"}}

0 commit comments

Comments
 (0)