arbi 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

arbi/types/api/config_retrieve_response.py

@@ -1,7 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 from typing import Dict, Union, Optional
-from typing_extensions import TypeAlias
+from typing_extensions import Literal, TypeAlias
 
 from pydantic import Field as FieldInfo
 
@@ -14,10 +14,102 @@ from .title_llm_config import TitleLlmConfig
 from .model_citation_config import ModelCitationConfig
 from .document_date_extractor_llm_config import DocumentDateExtractorLlmConfig
 
-__all__ = ["ConfigRetrieveResponse", "AllConfigs", "NonDeveloperConfig"]
+__all__ = [
+    "ConfigRetrieveResponse",
+    "AllConfigs",
+    "AllConfigsAgentLlm",
+    "AllConfigsAgents",
+    "AllConfigsEvaluatorLlm",
+    "NonDeveloperConfig",
+]
+
+
+class AllConfigsAgentLlm(BaseModel):
+    api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
+    """The inference type (local or remote)."""
+
+    enabled: Optional[bool] = FieldInfo(alias="ENABLED", default=None)
+    """Whether to use agent mode for queries."""
+
+    max_char_size_to_answer: Optional[int] = FieldInfo(alias="MAX_CHAR_SIZE_TO_ANSWER", default=None)
+    """Maximum character size for history."""
+
+    max_context_tokens: Optional[int] = FieldInfo(alias="MAX_CONTEXT_TOKENS", default=None)
+    """
+    Maximum tokens for gathered context (applies to evidence buffer and final
+    query).
+    """
+
+    max_iterations: Optional[int] = FieldInfo(alias="MAX_ITERATIONS", default=None)
+    """Maximum agent loop iterations."""
+
+    max_tokens: Optional[int] = FieldInfo(alias="MAX_TOKENS", default=None)
+    """Maximum tokens for planning decisions."""
+
+    api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
+    """The name of the model to be used."""
+
+    show_interim_steps: Optional[bool] = FieldInfo(alias="SHOW_INTERIM_STEPS", default=None)
+    """Whether to show agent's intermediate steps."""
+
+    system_instruction: Optional[str] = FieldInfo(alias="SYSTEM_INSTRUCTION", default=None)
+    """The system instruction for agent planning."""
+
+    temperature: Optional[float] = FieldInfo(alias="TEMPERATURE", default=None)
+    """Temperature for agent decisions."""
+
+
+class AllConfigsAgents(BaseModel):
+    agent_model_name: Optional[str] = FieldInfo(alias="AGENT_MODEL_NAME", default=None)
+    """The name of the model to be used for the agent."""
+
+    agent_prompt: Optional[str] = FieldInfo(alias="AGENT_PROMPT", default=None)
+
+    enabled: Optional[bool] = FieldInfo(alias="ENABLED", default=None)
+    """Whether to use agents mode for queries."""
+
+    llm_page_filter_model_name: Optional[str] = FieldInfo(alias="LLM_PAGE_FILTER_MODEL_NAME", default=None)
+    """The name of the model to be used for the llm page filter model."""
+
+    llm_page_filter_prompt: Optional[str] = FieldInfo(alias="LLM_PAGE_FILTER_PROMPT", default=None)
+
+    llm_page_filter_temperature: Optional[float] = FieldInfo(alias="LLM_PAGE_FILTER_TEMPERATURE", default=None)
+    """Temperature value for randomness."""
+
+    llm_summarise_model_name: Optional[str] = FieldInfo(alias="LLM_SUMMARISE_MODEL_NAME", default=None)
+    """The name of the model to be used for the llm summarise model."""
+
+    llm_summarise_prompt: Optional[str] = FieldInfo(alias="LLM_SUMMARISE_PROMPT", default=None)
+
+    llm_summarise_temperature: Optional[float] = FieldInfo(alias="LLM_SUMMARISE_TEMPERATURE", default=None)
+    """Temperature value for randomness."""
+
+
+class AllConfigsEvaluatorLlm(BaseModel):
+    api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
+    """The inference type (local or remote)."""
+
+    max_char_size_to_answer: Optional[int] = FieldInfo(alias="MAX_CHAR_SIZE_TO_ANSWER", default=None)
+    """Maximum character size for evaluation context."""
+
+    max_tokens: Optional[int] = FieldInfo(alias="MAX_TOKENS", default=None)
+    """Maximum tokens for evaluation response."""
+
+    api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
+    """The name of the non-reasoning model to be used."""
+
+    system_instruction: Optional[str] = FieldInfo(alias="SYSTEM_INSTRUCTION", default=None)
+    """The system instruction for chunk evaluation."""
+
+    temperature: Optional[float] = FieldInfo(alias="TEMPERATURE", default=None)
+    """Low temperature for consistent evaluation."""
 
 
 class AllConfigs(BaseModel):
+    agent_llm: Optional[AllConfigsAgentLlm] = FieldInfo(alias="AgentLLM", default=None)
+
+    agents: Optional[AllConfigsAgents] = FieldInfo(alias="Agents", default=None)
+
     chunker: Optional[object] = FieldInfo(alias="Chunker", default=None)
 
     document_date_extractor_llm: Optional[DocumentDateExtractorLlmConfig] = FieldInfo(
@@ -26,6 +118,8 @@ class AllConfigs(BaseModel):
 
     embedder: Optional[EmbedderConfig] = FieldInfo(alias="Embedder", default=None)
 
+    evaluator_llm: Optional[AllConfigsEvaluatorLlm] = FieldInfo(alias="EvaluatorLLM", default=None)
+
     api_model_citation: Optional[ModelCitationConfig] = FieldInfo(alias="ModelCitation", default=None)
 
     parser: Optional[object] = FieldInfo(alias="Parser", default=None)
@@ -40,6 +134,8 @@ class AllConfigs(BaseModel):
 
 
 class NonDeveloperConfig(BaseModel):
+    agent_llm: Dict[str, bool] = FieldInfo(alias="AgentLLM")
+
     query_llm: Dict[str, str] = FieldInfo(alias="QueryLLM")
 
 

arbi/types/api/conversation_retrieve_threads_response.py

@@ -14,17 +14,28 @@ __all__ = [
     "ThreadHistory",
     "ThreadHistoryTools",
     "ThreadHistoryToolsModelCitationTool",
+    "ThreadHistoryToolsModelCitationToolToolResponses",
     "ThreadHistoryToolsRetrievalChunkToolOutput",
     "ThreadHistoryToolsRetrievalFullContextToolOutput",
 ]
 
 
+class ThreadHistoryToolsModelCitationToolToolResponses(BaseModel):
+    chunk_ids: List[str]
+
+    offset_end: int
+
+    offset_start: int
+
+    statement: str
+
+
 class ThreadHistoryToolsModelCitationTool(BaseModel):
     description: Optional[str] = None
 
     name: Optional[Literal["model_citation"]] = None
 
-    tool_responses: Optional[Dict[str, List[str]]] = None
+    tool_responses: Optional[Dict[str, ThreadHistoryToolsModelCitationToolToolResponses]] = None
 
 
 class ThreadHistoryToolsRetrievalChunkToolOutput(BaseModel):
@@ -42,7 +53,7 @@ class ThreadHistoryToolsRetrievalFullContextToolOutput(BaseModel):
 
     name: Optional[Literal["retrieval_full_context"]] = None
 
-    tool_args: Optional[Dict[str, List[str]]] = None
+    tool_args: Optional[Dict[str, object]] = None
 
     tool_responses: Optional[Dict[str, List[Chunk]]] = None
 

arbi/types/api/document_date_extractor_llm_config.py

@@ -14,14 +14,14 @@ class DocumentDateExtractorLlmConfig(BaseModel):
     api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
     """The inference type (local or remote)."""
 
-    max_char_size_to_answer: Optional[int] = FieldInfo(alias="MAX_CHAR_SIZE_TO_ANSWER", default=None)
-    """Maximum character size to answer."""
+    max_char_context_to_answer: Optional[int] = FieldInfo(alias="MAX_CHAR_CONTEXT_TO_ANSWER", default=None)
+    """Maximum characters in document for context."""
 
     max_tokens: Optional[int] = FieldInfo(alias="MAX_TOKENS", default=None)
     """Maximum number of tokens allowed."""
 
     api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
-    """The name of the model to be used."""
+    """The name of the non-reasoning model to be used."""
 
     system_instruction: Optional[str] = FieldInfo(alias="SYSTEM_INSTRUCTION", default=None)
 

arbi/types/api/document_date_extractor_llm_config_param.py

@@ -13,14 +13,14 @@ class DocumentDateExtractorLlmConfigParam(TypedDict, total=False):
     api_type: Annotated[Literal["local", "remote"], PropertyInfo(alias="API_TYPE")]
     """The inference type (local or remote)."""
 
-    max_char_size_to_answer: Annotated[int, PropertyInfo(alias="MAX_CHAR_SIZE_TO_ANSWER")]
-    """Maximum character size to answer."""
+    max_char_context_to_answer: Annotated[int, PropertyInfo(alias="MAX_CHAR_CONTEXT_TO_ANSWER")]
+    """Maximum characters in document for context."""
 
     max_tokens: Annotated[int, PropertyInfo(alias="MAX_TOKENS")]
     """Maximum number of tokens allowed."""
 
     model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
-    """The name of the model to be used."""
+    """The name of the non-reasoning model to be used."""
 
     system_instruction: Annotated[str, PropertyInfo(alias="SYSTEM_INSTRUCTION")]
 

arbi/types/api/document_upload_from_url_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+from typing_extensions import Required, TypedDict
+
+from ..._types import SequenceNotStr
+
+__all__ = ["DocumentUploadFromURLParams"]
+
+
+class DocumentUploadFromURLParams(TypedDict, total=False):
+    urls: Required[SequenceNotStr[str]]
+    """URLs to download documents from"""
+
+    workspace_ext_id: Required[str]
+
+    config_ext_id: Optional[str]
+    """Configuration to use for processing"""
+
+    shared: bool
+    """Whether the document should be shared with workspace members"""

arbi/types/api/document_upload_params.py

@@ -2,10 +2,10 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import Required, TypedDict
 
-from ..._types import FileTypes
+from ..._types import FileTypes, SequenceNotStr
 
 __all__ = ["DocumentUploadParams"]
 
@@ -13,7 +13,7 @@ __all__ = ["DocumentUploadParams"]
 class DocumentUploadParams(TypedDict, total=False):
     workspace_ext_id: Required[str]
 
-    files: Required[List[FileTypes]]
+    files: Required[SequenceNotStr[FileTypes]]
     """Multiple files to upload"""
 
     config_ext_id: Optional[str]

arbi/types/api/embedder_config.py

@@ -14,5 +14,17 @@ class EmbedderConfig(BaseModel):
     api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
     """The inference type (local or remote)."""
 
+    batch_size: Optional[int] = FieldInfo(alias="BATCH_SIZE", default=None)
+    """Smaller batch size for better parallelization."""
+
+    embed_prefix: Optional[str] = FieldInfo(alias="EMBED_PREFIX", default=None)
+    """How to embed the sentence for retrieval."""
+
+    max_concurrent_requests: Optional[int] = FieldInfo(alias="MAX_CONCURRENT_REQUESTS", default=None)
+    """Adjust concurrency level as needed."""
+
     api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
     """The name of the embedder model."""
+
+    query_prefix: Optional[str] = FieldInfo(alias="QUERY_PREFIX", default=None)
+    """How to embed the sentence for query."""

arbi/types/api/embedder_config_param.py

@@ -13,5 +13,17 @@ class EmbedderConfigParam(TypedDict, total=False):
     api_type: Annotated[Literal["local", "remote"], PropertyInfo(alias="API_TYPE")]
     """The inference type (local or remote)."""
 
+    batch_size: Annotated[int, PropertyInfo(alias="BATCH_SIZE")]
+    """Smaller batch size for better parallelization."""
+
+    embed_prefix: Annotated[str, PropertyInfo(alias="EMBED_PREFIX")]
+    """How to embed the sentence for retrieval."""
+
+    max_concurrent_requests: Annotated[int, PropertyInfo(alias="MAX_CONCURRENT_REQUESTS")]
+    """Adjust concurrency level as needed."""
+
     model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
     """The name of the embedder model."""
+
+    query_prefix: Annotated[str, PropertyInfo(alias="QUERY_PREFIX")]
+    """How to embed the sentence for query."""

arbi/types/api/health_check_app_response.py

@@ -1,5 +1,7 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+from typing import Optional
+
 from ..._models import BaseModel
 
 __all__ = ["HealthCheckAppResponse"]
@@ -7,3 +9,7 @@ __all__ = ["HealthCheckAppResponse"]
 
 class HealthCheckAppResponse(BaseModel):
     status: str
+
+    backend_git_hash: Optional[str] = None
+
+    frontend_docker_version: Optional[str] = None

arbi/types/api/health_retrieve_status_response.py

@@ -0,0 +1,45 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["HealthRetrieveStatusResponse", "ModelsHealth", "ModelsHealthModel", "Service"]
+
+
+class ModelsHealthModel(BaseModel):
+    model: str
+
+    status: str
+
+    detail: Optional[str] = None
+
+
+class ModelsHealth(BaseModel):
+    application: str
+
+    models: List[ModelsHealthModel]
+
+
+class Service(BaseModel):
+    name: str
+
+    status: str
+
+    detail: Optional[str] = None
+
+    service_info: Optional[Dict[str, object]] = None
+
+
+class HealthRetrieveStatusResponse(BaseModel):
+    status: str
+
+    available_models: Optional[List[str]] = None
+
+    backend_git_hash: Optional[str] = None
+
+    frontend_docker_version: Optional[str] = None
+
+    models_health: Optional[ModelsHealth] = None
+
+    services: Optional[List[Service]] = None

arbi/types/api/health_retrieve_version_response.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict
+from typing_extensions import TypeAlias
+
+__all__ = ["HealthRetrieveVersionResponse"]
+
+HealthRetrieveVersionResponse: TypeAlias = Dict[str, object]

arbi/types/api/query_llm_config.py

@@ -21,7 +21,7 @@ class QueryLlmConfig(BaseModel):
     """Maximum number of tokens allowed."""
 
     api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
-    """The name of the model to be used."""
+    """The name of the non-reasoning model to be used."""
 
     system_instruction: Optional[str] = FieldInfo(alias="SYSTEM_INSTRUCTION", default=None)
     """The system instruction string."""

arbi/types/api/query_llm_config_param.py

@@ -20,7 +20,7 @@ class QueryLlmConfigParam(TypedDict, total=False):
     """Maximum number of tokens allowed."""
 
     model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
-    """The name of the model to be used."""
+    """The name of the non-reasoning model to be used."""
 
     system_instruction: Annotated[str, PropertyInfo(alias="SYSTEM_INSTRUCTION")]
     """The system instruction string."""

arbi/types/api/tag_apply_to_docs_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["TagApplyToDocsParams"]
 
 
 class TagApplyToDocsParams(TypedDict, total=False):
-    doc_ids: Required[List[str]]
+    doc_ids: Required[SequenceNotStr[str]]

arbi/types/api/tag_remove_from_docs_params.py

@@ -2,11 +2,12 @@
 
 from __future__ import annotations
 
-from typing import List
 from typing_extensions import Required, TypedDict
 
+from ..._types import SequenceNotStr
+
 __all__ = ["TagRemoveFromDocsParams"]
 
 
 class TagRemoveFromDocsParams(TypedDict, total=False):
-    doc_ids: Required[List[str]]
+    doc_ids: Required[SequenceNotStr[str]]

arbi/types/api/title_llm_config.py

@@ -21,7 +21,7 @@ class TitleLlmConfig(BaseModel):
     """Maximum number of tokens allowed."""
 
     api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
-    """The name of the model to be used."""
+    """The name of the non-reasoning model to be used."""
 
     system_instruction: Optional[str] = FieldInfo(alias="SYSTEM_INSTRUCTION", default=None)
 

arbi/types/api/title_llm_config_param.py

@@ -20,7 +20,7 @@ class TitleLlmConfigParam(TypedDict, total=False):
     """Maximum number of tokens allowed."""
 
     model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
-    """The name of the model to be used."""
+    """The name of the non-reasoning model to be used."""
 
     system_instruction: Annotated[str, PropertyInfo(alias="SYSTEM_INSTRUCTION")]
 

arbi/types/api/user/setting_retrieve_response.py

@@ -10,6 +10,8 @@ __all__ = ["SettingRetrieveResponse"]
 
 
 class SettingRetrieveResponse(BaseModel):
+    ai_mode: Optional[str] = None
+
     developer: Optional[bool] = None
 
     last_workspace: Optional[str] = None
@@ -26,11 +28,18 @@ class SettingRetrieveResponse(BaseModel):
 
     show_smart_search: Optional[bool] = None
 
+    show_templates: Optional[bool] = None
+
     show_thread_visualization: Optional[bool] = None
 
-    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
     if TYPE_CHECKING:
+        # Some versions of Pydantic <2.8.0 have a bug and don’t allow assigning a
+        # value to this field, so for compatibility we avoid doing it at runtime.
+        __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+
         # Stub to indicate that arbitrary properties are accepted.
         # To access properties that are not valid identifiers you can use `getattr`, e.g.
         # `getattr(obj, '$type')`
         def __getattr__(self, attr: str) -> object: ...
+    else:
+        __pydantic_extra__: Dict[str, object]

arbi/types/api/user/setting_update_params.py

@@ -2,14 +2,18 @@
 
 from __future__ import annotations
 
-from typing import List, Optional
+from typing import Optional
 from typing_extensions import TypedDict
 
+from ...._types import SequenceNotStr
+
 __all__ = ["SettingUpdateParams"]
 
 
 class SettingUpdateParams(TypedDict, total=False):
-    pinned_workspaces: Optional[List[str]]
+    ai_mode: Optional[str]
+
+    pinned_workspaces: Optional[SequenceNotStr[str]]
 
     show_document_navigator: Optional[bool]
 
@@ -21,4 +25,6 @@ class SettingUpdateParams(TypedDict, total=False):
 
     show_smart_search: Optional[bool]
 
+    show_templates: Optional[bool]
+
     show_thread_visualization: Optional[bool]

arbi/types/api/user_register_params.py

@@ -15,3 +15,5 @@ class UserRegisterParams(TypedDict, total=False):
     name: Required[str]
 
     password: Required[str]
+
+    verification_code: Required[str]

arbi/types/api/user_verify_email_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, TypedDict
+
+__all__ = ["UserVerifyEmailParams"]
+
+
+class UserVerifyEmailParams(TypedDict, total=False):
+    email: Required[str]

arbi/types/api/user_verify_email_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from ..._models import BaseModel
+
+__all__ = ["UserVerifyEmailResponse"]
+
+
+class UserVerifyEmailResponse(BaseModel):
+    detail: str

arbi/types/api/workspace_create_protected_params.py

@@ -12,3 +12,5 @@ class WorkspaceCreateProtectedParams(TypedDict, total=False):
     name: Required[str]
 
     description: Optional[str]
+
+    is_public: bool

arbi/types/api/workspace_response.py

@@ -17,6 +17,8 @@ class WorkspaceResponse(BaseModel):
 
     external_id: str
 
+    is_public: bool
+
     name: str
 
     updated_at: datetime

arbi/types/api/workspace_update_params.py

@@ -11,4 +11,6 @@ __all__ = ["WorkspaceUpdateParams"]
 class WorkspaceUpdateParams(TypedDict, total=False):
     description: Optional[str]
 
+    is_public: Optional[bool]
+
     name: Optional[str]

{arbi-0.1.0.dist-info → arbi-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arbi
-Version: 0.1.0
+Version: 0.2.0
 Summary: The official Python library for the arbi API
 Project-URL: Homepage, https://github.com/arbitrationcity/arbi-python
 Project-URL: Repository, https://github.com/arbitrationcity/arbi-python
@@ -147,9 +147,9 @@ from arbi import Arbi
 client = Arbi()
 
 config = client.api.configs.create(
-    document_date_extractor_llm={},
+    agent_llm={},
 )
-print(config.document_date_extractor_llm)
+print(config.agent_llm)
 ```
 
 ## Handling errors