lionagi 0.10.1__tar.gz → 0.10.2__tar.gz

{lionagi-0.10.1 → lionagi-0.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lionagi
-Version: 0.10.1
+Version: 0.10.2
 Summary: An Intelligence Operating System.
 Author-email: HaiyangLi <quantocean.li@gmail.com>
 License:            Apache License

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/_types.py

@@ -1 +1,2 @@
+from .fields import *
 from .protocols.types import *

lionagi-0.10.2/lionagi/fields/__init__.py

@@ -0,0 +1,35 @@
+from .action import (
+    ActionRequestModel,
+    ActionResponseModel,
+)
+from .base import (
+    CodeSnippet,
+    Outline,
+    OutlineItem,
+    Section,
+    Source,
+    TextSnippet,
+)
+from .file import CodeFile, Documentation, File
+from .instruct import (
+    Instruct,
+    InstructResponse,
+)
+from .reason import Reason
+
+__all__ = (
+    "ActionRequestModel",
+    "ActionResponseModel",
+    "Source",
+    "TextSnippet",
+    "CodeSnippet",
+    "Section",
+    "OutlineItem",
+    "Outline",
+    "File",
+    "CodeFile",
+    "Documentation",
+    "Instruct",
+    "InstructResponse",
+    "Reason",
+)

{lionagi-0.10.1/lionagi/libs → lionagi-0.10.2/lionagi}/fields/action.py

@@ -16,9 +16,7 @@ from lionagi.utils import to_dict, to_json, to_list
 
 __all__ = (
     "ActionRequestModel",
-    "ACTION_REQUESTS_FIELD",
     "ActionResponseModel",
-    "ACTION_RESPONSES_FIELD",
 )
 
 

lionagi-0.10.2/lionagi/fields/base.py

@@ -0,0 +1,151 @@
+from enum import Enum
+
+from pydantic import Field, HttpUrl
+
+from lionagi.models import HashableModel
+
+__all__ = (
+    "Source",
+    "TextSnippet",
+    "CodeSnippet",
+    "Section",
+    "OutlineItem",
+    "Outline",
+)
+
+
+class Source(HashableModel):
+    """
+    Represents a citation or external source, such as:
+     - a website,
+     - documentation link,
+     - research paper,
+     - or any external resource.
+    """
+
+    title: str = Field(
+        ...,
+        description="Short label or title for the reference (e.g. 'Pydantic Docs', 'RFC 3986').",
+    )
+
+    url: str | HttpUrl | None = Field(
+        None,
+        description="Full URL or local path pointing to the resource. Must conform to standard URL format.",
+    )
+
+    note: str | None = Field(
+        default=None,
+        description=(
+            "Optional additional note explaining why this reference is relevant or what it contains."
+        ),
+    )
+
+
+class SnippetType(str, Enum):
+    TEXT = "text"
+    CODE = "code"
+
+
+class TextSnippet(HashableModel):
+    """
+    Specialized snippet for textual/prose content.
+    """
+
+    type: SnippetType = Field(
+        SnippetType.TEXT,
+        description=(
+            "Must be 'text' for textual snippets. Ensures explicit type distinction."
+        ),
+    )
+    content: str = Field(
+        ...,
+        description=(
+            "The actual text. Can be a paragraph, bullet list, or any narrative content."
+        ),
+    )
+
+
+class CodeSnippet(HashableModel):
+    """
+    Specialized snippet for source code or command-line examples.
+    """
+
+    type: SnippetType = Field(
+        SnippetType.CODE,
+        description=(
+            "Must be 'code' for code snippets. Allows separate handling or formatting."
+        ),
+    )
+    content: str = Field(
+        ...,
+        description=(
+            "The actual code or command sequence. Should be well-formatted so it can be rendered properly."
+        ),
+    )
+
+
+class Section(HashableModel):
+    """
+    A single section of a document or article. Each section has:
+     - A title
+     - A sequential list of content snippets (text or code),
+       which appear in the intended reading order.
+     - Optional sources specifically cited in this section.
+    """
+
+    title: str = Field(
+        ...,
+        description=(
+            "The section heading or label, e.g., 'Introduction', 'Implementation Steps'."
+        ),
+    )
+    snippets: list[TextSnippet | CodeSnippet] = Field(
+        default_factory=list,
+        description=(
+            "Ordered list of content snippets. Could be multiple text blocks, code examples, etc."
+        ),
+    )
+
+    sources: list[Source] = Field(
+        default_factory=list,
+        description=(
+            "References specifically cited in this section. "
+            "If sources are stored at the doc-level, this can be omitted."
+        ),
+    )
+
+
+class OutlineItem(HashableModel):
+    """
+    Represents a single outline item, which could become a full section later.
+    """
+
+    heading: str = Field(
+        ...,
+        description="Short name or label for this item, e.g., 'Chapter 1: Basics'.",
+    )
+    summary: str | None = Field(
+        default=None,
+        description=(
+            "A brief description of what this section will cover, if known."
+        ),
+    )
+
+
+class Outline(HashableModel):
+    """
+    A top-level outline for a document or article.
+    Usually used in early planning stages.
+    """
+
+    topic: str = Field(
+        ..., description="Working title or overarching topic of the document."
+    )
+    items: list[OutlineItem] = Field(
+        default_factory=list,
+        description="List of major outline points or sections planned.",
+    )
+    notes: str | None = Field(
+        default=None,
+        description="Any additional remarks, questions, or brainstorming notes for the outline.",
+    )

{lionagi-0.10.1/lionagi/libs → lionagi-0.10.2/lionagi}/fields/file.py

@@ -1,16 +1,17 @@
 from pathlib import Path
 
-from pydantic import BaseModel, Field, field_validator
+from pydantic import Field, field_validator
 
-from lionagi.models import FieldModel
+from .base import HashableModel, Source
 
-
-class Source(BaseModel):
-    title: str | None = None
-    url: str | None = None
+__all__ = (
+    "File",
+    "CodeFile",
+    "Documentation",
+)
 
 
-class File(BaseModel):
+class File(HashableModel):
     """
     Represents a generic file with an optional name, content, and brief description.
     Useful for capturing and validating metadata about any kind of file within a project.
@@ -126,22 +127,4 @@ class Documentation(File):
     )
 
 
-FILE_FIELD = FieldModel(
-    name="file",
-    annotation=File | None,
-    default=None,
-)
-
-CODE_FILE_FIELD = FieldModel(
-    name="code_file",
-    annotation=CodeFile | None,
-    default=None,
-)
-
-DOCUMENTATION_FIELD = FieldModel(
-    name="documentation",
-    annotation=Documentation | None,
-    default=None,
-)
-
-# File: lionagi/libs/fields/file.py
+# File: lionagi/fields/file.py

{lionagi-0.10.1/lionagi/libs → lionagi-0.10.2/lionagi}/fields/instruct.py

@@ -16,8 +16,6 @@ from lionagi.utils import to_num
 __all__ = (
     "Instruct",
     "InstructResponse",
-    "INSTRUCT_FIELD",
-    "LIST_INSTRUCT_FIELD",
 )
 
 
@@ -150,4 +148,4 @@ LIST_INSTRUCT_FIELD_MODEL = FieldModel(
     default=None,
 )
 
-# File: lionagi/libs/fields/instruct.py
+# File: lionagi/fields/instruct.py

{lionagi-0.10.1/lionagi/libs → lionagi-0.10.2/lionagi}/fields/reason.py

@@ -7,12 +7,7 @@ from pydantic import BaseModel, Field, field_validator
 from lionagi.models import FieldModel
 from lionagi.utils import to_num
 
-__all__ = (
-    "Reason",
-    "REASON_FIELD",
-    "CONFIDENCE_SCORE_FIELD",
-    "validate_confidence_score",
-)
+__all__ = ("Reason",)
 
 
 class Reason(BaseModel):
@@ -51,15 +46,6 @@ def validate_confidence_score(cls, v):
         return -1
 
 
-CONFIDENCE_SCORE_FIELD = FieldModel(
-    name="confidence_score",
-    annotation=float | None,
-    default=None,
-    validator=validate_confidence_score,
-    validator_kwargs={"mode": "before"},
-)
-
-
 REASON_FIELD = FieldModel(
     name="reason",
     annotation=Reason | None,
@@ -67,4 +53,4 @@ REASON_FIELD = FieldModel(
     description="**Provide a concise reason for the decision made.**",
 )
 
-# File: lionagi/libs/fields/reason.py
+# File: lionagi/fields/reason.py

lionagi-0.10.2/lionagi/libs/package/imports.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2023 - 2025, HaiyangLi <quantocean.li at gmail dot com>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from lionagi.utils import (
+    check_import,
+    import_module,
+    install_import,
+    is_import_installed,
+    run_package_manager_command,
+)
+
+# backward compatibility
+
+__all__ = (
+    "run_package_manager_command",
+    "check_import",
+    "import_module",
+    "install_import",
+    "is_import_installed",
+)

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/ReAct/ReAct.py

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING, Any, Literal
 
 from pydantic import BaseModel
 
-from lionagi.libs.fields.instruct import Instruct
+from lionagi.fields.instruct import Instruct
 from lionagi.libs.schema.as_readable import as_readable
 from lionagi.libs.validate.common_field_validators import (
     validate_model_to_type,

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/_act/act.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING
 
 from pydantic import BaseModel
 
-from lionagi.libs.fields.action import ActionResponseModel
+from lionagi.fields.action import ActionResponseModel
 from lionagi.protocols.types import ActionRequest, Log
 
 if TYPE_CHECKING:

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/brainstorm/brainstorm.py

@@ -7,7 +7,7 @@ from typing import Any, Literal
 
 from pydantic import BaseModel
 
-from lionagi.libs.fields.instruct import (
+from lionagi.fields.instruct import (
     LIST_INSTRUCT_FIELD_MODEL,
     Instruct,
     InstructResponse,

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/instruct/instruct.py

@@ -4,7 +4,7 @@
 
 from typing import TYPE_CHECKING, Any
 
-from lionagi.libs.fields.instruct import Instruct
+from lionagi.fields.instruct import Instruct
 
 if TYPE_CHECKING:
     from lionagi.session.branch import Branch

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/operate/operate.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, Literal
 
 from pydantic import BaseModel, JsonValue
 
-from lionagi.libs.fields.instruct import Instruct
+from lionagi.fields.instruct import Instruct
 from lionagi.models import FieldModel, ModelParams
 from lionagi.protocols.types import (
     Instruction,

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/plan/plan.py

@@ -6,7 +6,7 @@ from typing import Any, Literal
 
 from pydantic import BaseModel
 
-from lionagi.libs.fields.instruct import (
+from lionagi.fields.instruct import (
     LIST_INSTRUCT_FIELD_MODEL,
     Instruct,
     InstructResponse,

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/select/select.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING, Any
 
 from pydantic import BaseModel
 
-from lionagi.libs.fields.instruct import Instruct
+from lionagi.fields.instruct import Instruct
 
 from .utils import SelectionModel
 

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/operations/utils.py

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-from lionagi.libs.fields.instruct import Instruct
+from lionagi.fields.instruct import Instruct
 from lionagi.session.session import Branch, Session
 
 

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/protocols/action/manager.py

@@ -4,11 +4,11 @@
 
 from typing import Any
 
+from lionagi.fields.action import ActionRequestModel
 from lionagi.protocols._concepts import Manager
 from lionagi.protocols.messages.action_request import ActionRequest
 from lionagi.utils import to_list
 
-from ...libs.fields.action import ActionRequestModel
 from .function_calling import FunctionCalling
 from .tool import FuncTool, FuncToolRef, Tool, ToolRef
 

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/protocols/operatives/step.py

@@ -5,14 +5,14 @@
 from pydantic import BaseModel, Field
 from pydantic.fields import FieldInfo
 
-from lionagi.libs.fields.action import (
+from lionagi.fields.action import (
     ACTION_REQUESTS_FIELD,
     ACTION_REQUIRED_FIELD,
     ACTION_RESPONSES_FIELD,
     ActionRequestModel,
     ActionResponseModel,
 )
-from lionagi.libs.fields.reason import REASON_FIELD, Reason
+from lionagi.fields.reason import REASON_FIELD, Reason
 from lionagi.models import FieldModel, ModelParams
 from lionagi.protocols.operatives.operative import Operative
 

{lionagi-0.10.1 → lionagi-0.10.2}/lionagi/session/branch.py

@@ -4,25 +4,20 @@
 
 from collections.abc import AsyncGenerator
 from enum import Enum
-from typing import TYPE_CHECKING, Any, Literal
+from typing import Any, Literal
 
 import pandas as pd
 from jinja2 import Template
 from pydantic import BaseModel, Field, JsonValue, PrivateAttr
 
+from lionagi.fields import Instruct
 from lionagi.libs.schema.as_readable import as_readable
 from lionagi.models.field_model import FieldModel
-from lionagi.models.model_params import ModelParams
-from lionagi.protocols.action.manager import ActionManager
 from lionagi.protocols.action.tool import FuncTool, Tool, ToolRef
-from lionagi.protocols.operatives.operative import Operative
-
-# Forward reference for Instruct which will be imported in the methods that use it
-# to avoid circular imports
-Instruct = Any
 from lionagi.protocols.types import (
     ID,
     MESSAGE_FIELDS,
+    ActionManager,
     ActionRequest,
     ActionResponse,
     AssistantResponse,
@@ -37,6 +32,7 @@ from lionagi.protocols.types import (
     Mailbox,
     MessageManager,
     MessageRole,
+    Operative,
     Package,
     PackageCategory,
     Pile,
@@ -54,10 +50,6 @@ from lionagi.utils import UNDEFINED, alcall, bcall, copy
 
 from .prompts import LION_SYSTEM_MESSAGE
 
-if TYPE_CHECKING:
-    # Forward references for type checking (e.g., in operations or extended modules)
-    from lionagi.session.branch import Branch
-
 __all__ = ("Branch",)
 
 
@@ -907,7 +899,6 @@ class Branch(Element, Communicatable, Relational):
         sender: SenderRecipient = None,
         recipient: SenderRecipient = None,
         progression: Progression = None,
-        imodel: iModel = None,  # deprecated, alias of chat_model
         chat_model: iModel = None,
         invoke_actions: bool = True,
         tool_schemas: list[dict] = None,
@@ -920,7 +911,6 @@ class Branch(Element, Communicatable, Relational):
         response_format: type[
             BaseModel
         ] = None,  # alias of operative.request_type
-        return_operative: bool = False,
         actions: bool = False,
         reason: bool = False,
         action_kwargs: dict = None,
@@ -931,15 +921,9 @@ class Branch(Element, Communicatable, Relational):
         verbose_action: bool = False,
         field_models: list[FieldModel] = None,
         exclude_fields: list | dict | None = None,
-        request_params: ModelParams = None,
-        request_param_kwargs: dict = None,
-        response_params: ModelParams = None,
-        response_param_kwargs: dict = None,
         handle_validation: Literal[
             "raise", "return_value", "return_none"
         ] = "return_value",
-        operative_model: type[BaseModel] = None,
-        request_model: type[BaseModel] = None,
         include_token_usage_to_model: bool = False,
         **kwargs,
     ) -> list | BaseModel | None | dict | str:
@@ -973,8 +957,7 @@ class Branch(Element, Communicatable, Relational):
                 The recipient ID for newly added messages.
             progression (Progression, optional):
                 Custom ordering of conversation messages.
-            imodel (iModel, deprecated):
-                Alias of `chat_model`.
+
             chat_model (iModel, optional):
                 The LLM used for the main chat operation. Defaults to `branch.chat_model`.
             invoke_actions (bool, optional):
@@ -995,8 +978,6 @@ class Branch(Element, Communicatable, Relational):
                 If provided, reuses an existing operative's config for parsing/validation.
             response_format (type[BaseModel], optional):
                 Expected Pydantic model for the final response (alias for `operative.request_type`).
-            return_operative (bool, optional):
-                If `True`, returns the entire `Operative` object after processing
                 rather than the structured or raw output.
             actions (bool, optional):
                 If `True`, signals that function-calling or "action" usage is expected.
@@ -1014,20 +995,8 @@ class Branch(Element, Communicatable, Relational):
                 Field-level definitions or overrides for the model schema.
             exclude_fields (list|dict|None, optional):
                 Which fields to exclude from final validation or model building.
-            request_params (ModelParams | None, optional):
-                Extra config for building the request model in the operative.
-            request_param_kwargs (dict|None, optional):
-                Additional kwargs passed to the `ModelParams` constructor for the request.
-            response_params (ModelParams | None, optional):
-                Config for building the response model after actions.
-            response_param_kwargs (dict|None, optional):
-                Additional kwargs passed to the `ModelParams` constructor for the response.
             handle_validation (Literal["raise","return_value","return_none"], optional):
                 How to handle parsing failures (default: "return_value").
-            operative_model (type[BaseModel], deprecated):
-                Alias for `response_format`.
-            request_model (type[BaseModel], optional):
-                Another alias for `response_format`.
             include_token_usage_to_model:
                 If `True`, includes token usage in the model messages.
             **kwargs:
@@ -1065,7 +1034,6 @@ class Branch(Element, Communicatable, Relational):
             tools=tools,
             operative=operative,
             response_format=response_format,
-            return_operative=return_operative,
             actions=actions,
             reason=reason,
             action_kwargs=action_kwargs,
@@ -1074,14 +1042,7 @@ class Branch(Element, Communicatable, Relational):
             verbose_action=verbose_action,
             field_models=field_models,
             exclude_fields=exclude_fields,
-            request_params=request_params,
-            request_param_kwargs=request_param_kwargs,
-            response_params=response_params,
-            response_param_kwargs=response_param_kwargs,
             handle_validation=handle_validation,
-            operative_model=operative_model,
-            request_model=request_model,
-            imodel=imodel,
             include_token_usage_to_model=include_token_usage_to_model,
             **kwargs,
         )
@@ -1096,19 +1057,15 @@ class Branch(Element, Communicatable, Relational):
         sender: SenderRecipient = None,
         recipient: SenderRecipient = None,
         progression: ID.IDSeq = None,
-        request_model: type[BaseModel] | BaseModel | None = None,
         response_format: type[BaseModel] = None,
         request_fields: dict | list[str] = None,
-        imodel: iModel = None,  # alias of chat_model
         chat_model: iModel = None,
         parse_model: iModel = None,
         skip_validation: bool = False,
         images: list = None,
         image_detail: Literal["low", "high", "auto"] = None,
         num_parse_retries: int = 3,
-        fuzzy_match_kwargs: dict = None,
         clear_messages: bool = False,
-        operative_model: type[BaseModel] = None,
         include_token_usage_to_model: bool = False,
         **kwargs,
     ):
@@ -1135,14 +1092,10 @@ class Branch(Element, Communicatable, Relational):
                 Recipient ID (defaults to `self.id`).
             progression (ID.IDSeq, optional):
                 Custom ordering of messages.
-            request_model (type[BaseModel] | BaseModel | None, optional):
-                Model for validating or structuring the LLM's response.
             response_format (type[BaseModel], optional):
                 Alias for `request_model`. If both are provided, raises ValueError.
             request_fields (dict|list[str], optional):
                 If you only need certain fields from the LLM's response.
-            imodel (iModel, optional):
-                Deprecated alias for `chat_model`.
             chat_model (iModel, optional):
                 An alternative to the default chat model.
             parse_model (iModel, optional):
@@ -1155,12 +1108,8 @@ class Branch(Element, Communicatable, Relational):
                 Image detail level (if used).
             num_parse_retries (int, optional):
                 Maximum parsing retries (capped at 5).
-            fuzzy_match_kwargs (dict, optional):
-                Additional settings for fuzzy field matching (if used).
             clear_messages (bool, optional):
                 Whether to clear stored messages before sending.
-            operative_model (type[BaseModel], optional):
-                Deprecated, alias for `response_format`.
             **kwargs:
                 Additional arguments for the underlying LLM call.
 
@@ -1182,18 +1131,15 @@ class Branch(Element, Communicatable, Relational):
             sender=sender,
             recipient=recipient,
             progression=progression,
-            request_model=request_model,
             response_format=response_format,
             request_fields=request_fields,
-            chat_model=kwargs.pop("chat_model", None) or chat_model or imodel,
+            chat_model=chat_model,
             parse_model=parse_model,
             skip_validation=skip_validation,
             images=images,
             image_detail=image_detail,
             num_parse_retries=num_parse_retries,
-            fuzzy_match_kwargs=fuzzy_match_kwargs,
             clear_messages=clear_messages,
-            operative_model=operative_model,
             include_token_usage_to_model=include_token_usage_to_model,
             **kwargs,
         )