arbi 0.18.0__py3-none-any.whl

arbi/types/api/config_retrieve_response.py

@@ -0,0 +1,234 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Union, Optional
+from typing_extensions import Literal, TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from .embedder_config import EmbedderConfig
+from .reranker_config import RerankerConfig
+from .query_llm_config import QueryLlmConfig
+from .retriever_config import RetrieverConfig
+from .title_llm_config import TitleLlmConfig
+from .model_citation_config import ModelCitationConfig
+from .document_date_extractor_llm_config import DocumentDateExtractorLlmConfig
+
+__all__ = [
+    "ConfigRetrieveResponse",
+    "AllConfigs",
+    "AllConfigsAgentLlm",
+    "AllConfigsAgents",
+    "AllConfigsDoctagLlm",
+    "AllConfigsDocumentSummaryExtractorLlm",
+    "AllConfigsEvaluatorLlm",
+    "AllConfigsKeywordEmbedder",
+    "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_agent_temperature: Optional[float] = FieldInfo(alias="LLM_AGENT_TEMPERATURE", default=None)
+    """Temperature value for randomness."""
+
+    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 AllConfigsDoctagLlm(BaseModel):
+    """
+    Configuration for DoctagLLM - extracts information from documents based on tag instructions.
+    """
+
+    api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
+    """The inference type (local or remote)."""
+
+    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 for all answers."""
+
+    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)
+
+    temperature: Optional[float] = FieldInfo(alias="TEMPERATURE", default=None)
+    """Temperature for factual answers."""
+
+
+class AllConfigsDocumentSummaryExtractorLlm(BaseModel):
+    api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
+    """The inference type (local or remote)."""
+
+    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 non-reasoning model to be used."""
+
+    system_instruction: Optional[str] = FieldInfo(alias="SYSTEM_INSTRUCTION", default=None)
+
+    temperature: Optional[float] = FieldInfo(alias="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 AllConfigsKeywordEmbedder(BaseModel):
+    """Configuration for keyword embedder with BM25 scoring."""
+
+    bm25_avgdl: Optional[float] = FieldInfo(alias="BM25_AVGDL", default=None)
+    """Average document length in tokens.
+
+    Adjust based on your documents: chat messages ~20-50, articles ~100-300, papers
+    ~1000+
+    """
+
+    bm25_b: Optional[float] = FieldInfo(alias="BM25_B", default=None)
+    """BM25 document length normalization (0.0-1.0).
+
+    0=ignore length, 1=full penalty for long docs. Default 0.75 is standard.
+    """
+
+    bm25_k1: Optional[float] = FieldInfo(alias="BM25_K1", default=None)
+    """BM25 term frequency saturation (1.2-2.0).
+
+    Higher = more weight on term repetition. Default 1.5 works for most cases.
+    """
+
+    dimension_space: Optional[int] = FieldInfo(alias="DIMENSION_SPACE", default=None)
+    """Total dimension space for hash trick (1,048,576 dimensions)"""
+
+    filter_stopwords: Optional[bool] = FieldInfo(alias="FILTER_STOPWORDS", default=None)
+    """Remove common stopwords to reduce noise"""
+
+
+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)
+
+    doctag_llm: Optional[AllConfigsDoctagLlm] = FieldInfo(alias="DoctagLLM", default=None)
+    """
+    Configuration for DoctagLLM - extracts information from documents based on tag
+    instructions.
+    """
+
+    document_date_extractor_llm: Optional[DocumentDateExtractorLlmConfig] = FieldInfo(
+        alias="DocumentDateExtractorLLM", default=None
+    )
+
+    document_summary_extractor_llm: Optional[AllConfigsDocumentSummaryExtractorLlm] = FieldInfo(
+        alias="DocumentSummaryExtractorLLM", default=None
+    )
+
+    embedder: Optional[EmbedderConfig] = FieldInfo(alias="Embedder", default=None)
+
+    evaluator_llm: Optional[AllConfigsEvaluatorLlm] = FieldInfo(alias="EvaluatorLLM", default=None)
+
+    keyword_embedder: Optional[AllConfigsKeywordEmbedder] = FieldInfo(alias="KeywordEmbedder", default=None)
+    """Configuration for keyword embedder with BM25 scoring."""
+
+    api_model_citation: Optional[ModelCitationConfig] = FieldInfo(alias="ModelCitation", default=None)
+
+    parser: Optional[object] = FieldInfo(alias="Parser", default=None)
+
+    query_llm: Optional[QueryLlmConfig] = FieldInfo(alias="QueryLLM", default=None)
+
+    reranker: Optional[RerankerConfig] = FieldInfo(alias="Reranker", default=None)
+
+    retriever: Optional[RetrieverConfig] = FieldInfo(alias="Retriever", default=None)
+
+    title_llm: Optional[TitleLlmConfig] = FieldInfo(alias="TitleLLM", default=None)
+
+
+class NonDeveloperConfig(BaseModel):
+    """Limited configuration response for non-developer users"""
+
+    agent_llm: Dict[str, bool] = FieldInfo(alias="AgentLLM")
+
+    query_llm: Dict[str, str] = FieldInfo(alias="QueryLLM")
+
+
+ConfigRetrieveResponse: TypeAlias = Union[AllConfigs, NonDeveloperConfig]

arbi/types/api/conversation/__init__.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .user_add_params import UserAddParams as UserAddParams
+from .user_add_response import UserAddResponse as UserAddResponse
+from .user_remove_params import UserRemoveParams as UserRemoveParams
+from .user_remove_response import UserRemoveResponse as UserRemoveResponse

arbi/types/api/conversation/user_add_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__ = ["UserAddParams"]
+
+
+class UserAddParams(TypedDict, total=False):
+    user_ext_id: Required[str]

arbi/types/api/conversation/user_add_response.py

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

arbi/types/api/conversation/user_remove_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__ = ["UserRemoveParams"]
+
+
+class UserRemoveParams(TypedDict, total=False):
+    user_ext_id: Required[str]

arbi/types/api/conversation/user_remove_response.py

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

arbi/types/api/conversation_delete_message_response.py

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

arbi/types/api/conversation_delete_response.py

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

arbi/types/api/conversation_retrieve_message_response.py

@@ -0,0 +1,105 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from ..chunk import Chunk
+from ..._utils import PropertyInfo
+from ..._models import BaseModel
+
+__all__ = [
+    "ConversationRetrieveMessageResponse",
+    "Tools",
+    "ToolsModelCitationTool",
+    "ToolsModelCitationToolToolResponses",
+    "ToolsRetrievalChunkToolOutput",
+    "ToolsRetrievalFullContextToolOutput",
+    "ToolsTraceTool",
+]
+
+
+class ToolsModelCitationToolToolResponses(BaseModel):
+    """Data for a single citation - shared by DocTags and ModelCitationTool."""
+
+    chunk_ids: List[str]
+
+    offset_end: int
+
+    offset_start: int
+
+    statement: str
+
+
+class ToolsModelCitationTool(BaseModel):
+    description: Optional[str] = None
+
+    name: Optional[Literal["model_citation"]] = None
+
+    tool_responses: Optional[Dict[str, ToolsModelCitationToolToolResponses]] = None
+
+
+class ToolsRetrievalChunkToolOutput(BaseModel):
+    description: Optional[str] = None
+
+    name: Optional[Literal["retrieval_chunk"]] = None
+
+    tool_args: Optional[Dict[str, List[str]]] = None
+
+    tool_responses: Optional[Dict[str, List[Chunk]]] = None
+
+
+class ToolsRetrievalFullContextToolOutput(BaseModel):
+    description: Optional[str] = None
+
+    name: Optional[Literal["retrieval_full_context"]] = None
+
+    tool_args: Optional[Dict[str, object]] = None
+
+    tool_responses: Optional[Dict[str, List[Chunk]]] = None
+
+
+class ToolsTraceTool(BaseModel):
+    """Execution trace tool that captures the full execution history of a request."""
+
+    description: Optional[str] = None
+
+    duration_seconds: Optional[float] = None
+
+    name: Optional[Literal["trace"]] = None
+
+    start_time: Optional[float] = None
+
+    steps: Optional[List[Dict[str, object]]] = None
+
+    trace_id: Optional[str] = None
+
+
+Tools: TypeAlias = Annotated[
+    Union[ToolsModelCitationTool, ToolsRetrievalChunkToolOutput, ToolsRetrievalFullContextToolOutput, ToolsTraceTool],
+    PropertyInfo(discriminator="name"),
+]
+
+
+class ConversationRetrieveMessageResponse(BaseModel):
+    """DTO for API responses to frontend - all fields guaranteed to be present"""
+
+    content: str
+
+    conversation_ext_id: str
+
+    created_at: datetime
+
+    created_by_ext_id: str
+
+    external_id: str
+
+    role: Literal["user", "assistant", "system"]
+
+    config_ext_id: Optional[str] = None
+
+    parent_message_ext_id: Optional[str] = None
+
+    shared: Optional[bool] = None
+
+    tools: Optional[Dict[str, Tools]] = None

arbi/types/api/conversation_retrieve_threads_response.py

@@ -0,0 +1,124 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypeAlias
+
+from ..chunk import Chunk
+from ..._utils import PropertyInfo
+from ..._models import BaseModel
+
+__all__ = [
+    "ConversationRetrieveThreadsResponse",
+    "Thread",
+    "ThreadHistory",
+    "ThreadHistoryTools",
+    "ThreadHistoryToolsModelCitationTool",
+    "ThreadHistoryToolsModelCitationToolToolResponses",
+    "ThreadHistoryToolsRetrievalChunkToolOutput",
+    "ThreadHistoryToolsRetrievalFullContextToolOutput",
+    "ThreadHistoryToolsTraceTool",
+]
+
+
+class ThreadHistoryToolsModelCitationToolToolResponses(BaseModel):
+    """Data for a single citation - shared by DocTags and ModelCitationTool."""
+
+    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, ThreadHistoryToolsModelCitationToolToolResponses]] = None
+
+
+class ThreadHistoryToolsRetrievalChunkToolOutput(BaseModel):
+    description: Optional[str] = None
+
+    name: Optional[Literal["retrieval_chunk"]] = None
+
+    tool_args: Optional[Dict[str, List[str]]] = None
+
+    tool_responses: Optional[Dict[str, List[Chunk]]] = None
+
+
+class ThreadHistoryToolsRetrievalFullContextToolOutput(BaseModel):
+    description: Optional[str] = None
+
+    name: Optional[Literal["retrieval_full_context"]] = None
+
+    tool_args: Optional[Dict[str, object]] = None
+
+    tool_responses: Optional[Dict[str, List[Chunk]]] = None
+
+
+class ThreadHistoryToolsTraceTool(BaseModel):
+    """Execution trace tool that captures the full execution history of a request."""
+
+    description: Optional[str] = None
+
+    duration_seconds: Optional[float] = None
+
+    name: Optional[Literal["trace"]] = None
+
+    start_time: Optional[float] = None
+
+    steps: Optional[List[Dict[str, object]]] = None
+
+    trace_id: Optional[str] = None
+
+
+ThreadHistoryTools: TypeAlias = Annotated[
+    Union[
+        ThreadHistoryToolsModelCitationTool,
+        ThreadHistoryToolsRetrievalChunkToolOutput,
+        ThreadHistoryToolsRetrievalFullContextToolOutput,
+        ThreadHistoryToolsTraceTool,
+    ],
+    PropertyInfo(discriminator="name"),
+]
+
+
+class ThreadHistory(BaseModel):
+    """DTO for API responses to frontend - all fields guaranteed to be present"""
+
+    content: str
+
+    conversation_ext_id: str
+
+    created_at: datetime
+
+    created_by_ext_id: str
+
+    external_id: str
+
+    role: Literal["user", "assistant", "system"]
+
+    config_ext_id: Optional[str] = None
+
+    parent_message_ext_id: Optional[str] = None
+
+    shared: Optional[bool] = None
+
+    tools: Optional[Dict[str, ThreadHistoryTools]] = None
+
+
+class Thread(BaseModel):
+    history: List[ThreadHistory]
+
+    leaf_message_ext_id: str
+
+
+class ConversationRetrieveThreadsResponse(BaseModel):
+    conversation_ext_id: str
+
+    threads: List[Thread]

arbi/types/api/conversation_share_response.py

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

arbi/types/api/conversation_update_title_params.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ConversationUpdateTitleParams"]
+
+
+class ConversationUpdateTitleParams(TypedDict, total=False):
+    title: Required[str]
+    """New conversation title (1-60 characters)"""
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]

arbi/types/api/conversation_update_title_response.py

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

arbi/types/api/doc_response.py

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import date, datetime
+
+from ..._models import BaseModel
+from .document.doc_tag_response import DocTagResponse
+
+__all__ = ["DocResponse", "DocMetadata"]
+
+
+class DocMetadata(BaseModel):
+    """Structured model for document metadata stored in JSONB column."""
+
+    doc_author: Optional[str] = None
+
+    doc_date: Optional[date] = None
+
+    doc_nature: Optional[str] = None
+
+    doc_subject: Optional[str] = None
+
+    title: Optional[str] = None
+
+
+class DocResponse(BaseModel):
+    created_at: datetime
+
+    created_by_ext_id: str
+
+    external_id: str
+
+    updated_at: datetime
+
+    workspace_ext_id: str
+
+    config_ext_id: Optional[str] = None
+
+    doc_metadata: Optional[DocMetadata] = None
+    """Structured model for document metadata stored in JSONB column."""
+
+    doctags: Optional[List[DocTagResponse]] = None
+
+    file_name: Optional[str] = None
+
+    file_size: Optional[int] = None
+
+    file_type: Optional[str] = None
+
+    n_chunks: Optional[int] = None
+
+    n_pages: Optional[int] = None
+
+    re_ocred: Optional[bool] = None
+
+    shared: Optional[bool] = None
+
+    status: Optional[str] = None
+
+    storage_type: Optional[str] = None
+
+    storage_uri: Optional[str] = None
+
+    tokens: Optional[int] = None
+
+    updated_by_ext_id: Optional[str] = None

arbi/types/api/document/__init__.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .doc_tag_response import DocTagResponse as DocTagResponse
+from .doctag_create_params import DoctagCreateParams as DoctagCreateParams
+from .doctag_delete_params import DoctagDeleteParams as DoctagDeleteParams
+from .doctag_update_params import DoctagUpdateParams as DoctagUpdateParams
+from .doctag_create_response import DoctagCreateResponse as DoctagCreateResponse
+from .doctag_generate_params import DoctagGenerateParams as DoctagGenerateParams
+from .doctag_generate_response import DoctagGenerateResponse as DoctagGenerateResponse