openai-sdk-helpers 0.4.3__tar.gz → 0.5.1__tar.gz

{openai_sdk_helpers-0.4.3 → openai_sdk_helpers-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openai-sdk-helpers
-Version: 0.4.3
+Version: 0.5.1
 Summary: Composable helpers for OpenAI SDK agents, prompts, and storage
 Author: openai-sdk-helpers maintainers
 License: MIT
@@ -17,6 +17,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Requires-Dist: jinja2
+Requires-Dist: langextract
 Requires-Dist: openai-agents<1.0.0,>=0.6.4
 Requires-Dist: openai<3.0.0,>=2.14.0
 Requires-Dist: pydantic<3,>=2.7
@@ -31,6 +32,8 @@ Requires-Dist: pyright; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-asyncio; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
+Provides-Extra: extract
+Requires-Dist: langextract; extra == 'extract'
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -78,7 +81,7 @@ structures, configuration helpers, and orchestration utilities—while leaving
 application-specific prompts and tools to the consuming project.
 
 **Important**: This library integrates with **two distinct OpenAI SDKs**:
-- **`openai-agents`** - Used by the `agent` module for high-level agent workflows with automatic tool handling and streaming
+- **`openai-agents`** - Used by the `agent` module for high-level agent workflows with automatic tool handling
 - **`openai`** - Used by the `response` module for direct API interactions with fine-grained control over responses
 
 The `agent` module provides a higher-level abstraction for building agents, while the `response` module offers lower-level control for custom response handling workflows.
@@ -302,7 +305,7 @@ response.close()
 ```
 
 **Key Differences:**
-- **Agent Module**: Higher-level abstraction with built-in streaming, automatic tool handling, and agent-specific workflows
+- **Agent Module**: Higher-level abstraction with automatic tool handling and agent-specific workflows
 - **Response Module**: Lower-level control with manual message management, custom tool handlers, and direct API access
 
 ## Advanced Usage
@@ -327,7 +330,7 @@ with ResponseBase(
 ) as response:
     # Automatic type detection - single files parameter
     # Images are sent as base64-encoded images
-    # Documents are sent as base64-encoded file data
+    # PDF documents are sent as base64-encoded file data
     result = response.run_sync(
         "Analyze these files",
         files=["photo.jpg", "document.pdf"]
@@ -353,7 +356,8 @@ with ResponseBase(
 **How It Works:**
 
 - **Images** (jpg, png, gif, etc.) are automatically sent as base64-encoded images
-- **Documents** (pdf, txt, xlsx, etc.) are sent as base64-encoded file data by default
+- **Documents** are sent as base64-encoded file data by default for PDFs only
+- **Non-PDF documents** should use `use_vector_store=True` (or be converted to PDF)
 - **Vector Stores** can optionally be used for documents when `use_vector_store=True`
 - **Batch Processing** is automatically used for multiple files (>3) for efficient encoding
 
@@ -523,7 +527,7 @@ The package is organized around cohesive, reusable building blocks:
 
 ### Agent Modules (Built on `openai-agents` SDK)
 
-These modules use the `openai-agents` SDK for high-level agent workflows with automatic streaming, tool handling, and conversation management.
+These modules use the `openai-agents` SDK for high-level agent workflows with automatic tool handling and conversation management.
 
 - **`openai_sdk_helpers.agent.base.AgentBase`**  
   Base class for all agents with synchronous and asynchronous execution support.
@@ -585,6 +589,17 @@ These modules use the standard `openai` SDK for direct API interactions with fin
 - **`openai_sdk_helpers.utils`**  
   JSON serialization helpers, logging utilities, and common validation functions.
 
+- **`openai_sdk_helpers.utils.langextract`**  
+  Adapter helpers for running LangExtract-style extractors and validating the
+  results into Pydantic models.
+
+## Related Projects
+
+- **[LangExtract](https://github.com/google/langextract)**  
+  Google-maintained toolkit for extracting structured data from language model
+  outputs, which can complement the validation and response utilities in
+  `openai-sdk-helpers`.
+
 ## Contributing
 
 Contributions are welcome! We appreciate functional changes accompanied by

{openai_sdk_helpers-0.4.3 → openai_sdk_helpers-0.5.1}/README.md

@@ -43,7 +43,7 @@ structures, configuration helpers, and orchestration utilities—while leaving
 application-specific prompts and tools to the consuming project.
 
 **Important**: This library integrates with **two distinct OpenAI SDKs**:
-- **`openai-agents`** - Used by the `agent` module for high-level agent workflows with automatic tool handling and streaming
+- **`openai-agents`** - Used by the `agent` module for high-level agent workflows with automatic tool handling
 - **`openai`** - Used by the `response` module for direct API interactions with fine-grained control over responses
 
 The `agent` module provides a higher-level abstraction for building agents, while the `response` module offers lower-level control for custom response handling workflows.
@@ -267,7 +267,7 @@ response.close()
 ```
 
 **Key Differences:**
-- **Agent Module**: Higher-level abstraction with built-in streaming, automatic tool handling, and agent-specific workflows
+- **Agent Module**: Higher-level abstraction with automatic tool handling and agent-specific workflows
 - **Response Module**: Lower-level control with manual message management, custom tool handlers, and direct API access
 
 ## Advanced Usage
@@ -292,7 +292,7 @@ with ResponseBase(
 ) as response:
     # Automatic type detection - single files parameter
     # Images are sent as base64-encoded images
-    # Documents are sent as base64-encoded file data
+    # PDF documents are sent as base64-encoded file data
     result = response.run_sync(
         "Analyze these files",
         files=["photo.jpg", "document.pdf"]
@@ -318,7 +318,8 @@ with ResponseBase(
 **How It Works:**
 
 - **Images** (jpg, png, gif, etc.) are automatically sent as base64-encoded images
-- **Documents** (pdf, txt, xlsx, etc.) are sent as base64-encoded file data by default
+- **Documents** are sent as base64-encoded file data by default for PDFs only
+- **Non-PDF documents** should use `use_vector_store=True` (or be converted to PDF)
 - **Vector Stores** can optionally be used for documents when `use_vector_store=True`
 - **Batch Processing** is automatically used for multiple files (>3) for efficient encoding
 
@@ -488,7 +489,7 @@ The package is organized around cohesive, reusable building blocks:
 
 ### Agent Modules (Built on `openai-agents` SDK)
 
-These modules use the `openai-agents` SDK for high-level agent workflows with automatic streaming, tool handling, and conversation management.
+These modules use the `openai-agents` SDK for high-level agent workflows with automatic tool handling and conversation management.
 
 - **`openai_sdk_helpers.agent.base.AgentBase`**  
   Base class for all agents with synchronous and asynchronous execution support.
@@ -550,6 +551,17 @@ These modules use the standard `openai` SDK for direct API interactions with fin
 - **`openai_sdk_helpers.utils`**  
   JSON serialization helpers, logging utilities, and common validation functions.
 
+- **`openai_sdk_helpers.utils.langextract`**  
+  Adapter helpers for running LangExtract-style extractors and validating the
+  results into Pydantic models.
+
+## Related Projects
+
+- **[LangExtract](https://github.com/google/langextract)**  
+  Google-maintained toolkit for extracting structured data from language model
+  outputs, which can complement the validation and response utilities in
+  `openai-sdk-helpers`.
+
 ## Contributing
 
 Contributions are welcome! We appreciate functional changes accompanied by

{openai_sdk_helpers-0.4.3 → openai_sdk_helpers-0.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "openai-sdk-helpers"
-version = "0.4.3"
+version = "0.5.1"
 requires-python = ">=3.10"
 readme = "README.md"
 description = "Composable helpers for OpenAI SDK agents, prompts, and storage"
@@ -36,7 +36,8 @@ dependencies = [
     # OpenAI functionality (tested with openai==2.14.0, openai-agents==0.6.4)
     "openai>=2.14.0,<3.0.0",
     "openai-agents>=0.6.4,<1.0.0",
-
+    # Language extraction
+    "langextract",
 
     # Web UI
     "streamlit",
@@ -57,6 +58,9 @@ dev = [
     "pytest",
     "pytest-asyncio",
 ]
+extract = [
+    "langextract",
+]
 
 [build-system]
 requires = ["hatchling"]

{openai_sdk_helpers-0.4.3 → openai_sdk_helpers-0.5.1}/src/openai_sdk_helpers/__init__.py

@@ -16,6 +16,7 @@ from .errors import (
     InputValidationError,
     AsyncExecutionError,
     ResourceCleanupError,
+    ExtractionError,
 )
 
 from .utils.validation import (
@@ -40,6 +41,11 @@ from .structure import (
     ExtendedSummaryStructure,
     ValidationResultStructure,
     AgentBlueprint,
+    AnnotatedDocumentStructure,
+    AttributeStructure,
+    DocumentStructure,
+    ExampleDataStructure,
+    ExtractionStructure,
     create_plan,
     execute_task,
     execute_plan,
@@ -67,15 +73,15 @@ from .response import (
     ResponseConfiguration,
     ResponseRegistry,
     get_default_registry,
-    parse_tool_arguments,
     attach_vector_store,
 )
 from .tools import (
-    serialize_tool_result,
     tool_handler_factory,
     StructureType,
+    ToolHandler,
+    ToolHandlerRegistration,
     ToolSpec,
-    build_tool_definitions,
+    build_tool_definition_list,
 )
 from .settings import build_openai_settings
 from .utils.output_validation import (
@@ -87,7 +93,17 @@ from .utils.output_validation import (
     OutputValidator,
     validate_output,
 )
-
+from .utils.langextract import LangExtractAdapter, build_langextract_adapter
+from .extract import (
+    DocumentExtractor,
+    EXTRACTOR_CONFIG_AGENT_INSTRUCTIONS,
+    EXTRACTOR_CONFIG_GENERATOR,
+    PROMPT_OPTIMIZER_AGENT_INSTRUCTIONS,
+    generate_document_extractor_config,
+    generate_document_extractor_config_with_agent,
+    optimize_extractor_prompt,
+    optimize_extractor_prompt_with_agent,
+)
 
 __all__ = [
     # Environment utilities
@@ -106,6 +122,7 @@ __all__ = [
     "InputValidationError",
     "AsyncExecutionError",
     "ResourceCleanupError",
+    "ExtractionError",
     # Validation
     "validate_non_empty_string",
     "validate_max_length",
@@ -143,6 +160,11 @@ __all__ = [
     "WebSearchStructure",
     "VectorSearchStructure",
     "ValidationResultStructure",
+    "AnnotatedDocumentStructure",
+    "AttributeStructure",
+    "DocumentStructure",
+    "ExampleDataStructure",
+    "ExtractionStructure",
     "ResponseBase",
     "ResponseMessage",
     "ResponseMessages",
@@ -150,13 +172,13 @@ __all__ = [
     "ResponseConfiguration",
     "ResponseRegistry",
     "get_default_registry",
-    "parse_tool_arguments",
     "attach_vector_store",
-    "serialize_tool_result",
     "tool_handler_factory",
     "StructureType",
+    "ToolHandler",
+    "ToolHandlerRegistration",
     "ToolSpec",
-    "build_tool_definitions",
+    "build_tool_definition_list",
     "build_openai_settings",
     "create_plan",
     "execute_task",
@@ -169,4 +191,16 @@ __all__ = [
     "LengthValidator",
     "OutputValidator",
     "validate_output",
+    # LangExtract
+    "LangExtractAdapter",
+    "build_langextract_adapter",
+    # Extraction helpers
+    "DocumentExtractor",
+    "EXTRACTOR_CONFIG_AGENT_INSTRUCTIONS",
+    "EXTRACTOR_CONFIG_GENERATOR",
+    "PROMPT_OPTIMIZER_AGENT_INSTRUCTIONS",
+    "generate_document_extractor_config",
+    "generate_document_extractor_config_with_agent",
+    "optimize_extractor_prompt",
+    "optimize_extractor_prompt_with_agent",
 ]

{openai_sdk_helpers-0.4.3 → openai_sdk_helpers-0.5.1}/src/openai_sdk_helpers/agent/__init__.py

@@ -5,7 +5,7 @@ from .base import AgentBase
 from .configuration import AgentConfiguration, AgentRegistry, get_default_registry
 from ..structure.plan.enum import AgentEnum
 from .coordinator import CoordinatorAgent
-from .runner import run_sync, run_async, run_streamed
+from .runner import run_sync, run_async
 from .search.base import SearchPlanner, SearchToolAgent, SearchWriter
 from .summarizer import SummarizerAgent
 from .translator import TranslatorAgent
@@ -23,7 +23,6 @@ __all__ = [
     "CoordinatorAgent",
     "run_sync",
     "run_async",
-    "run_streamed",
     "run_coroutine_agent_sync",
     "SearchPlanner",
     "SearchToolAgent",