arbi 0.18.0__py3-none-any.whl

arbi/types/api/notification_create_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+from .user_response import UserResponse
+
+__all__ = ["NotificationCreateResponse", "NotificationCreateResponseItem"]
+
+
+class NotificationCreateResponseItem(BaseModel):
+    """Notification response model for API and WebSocket.
+
+    Bilateral: both sender and recipient see the same row.
+    Client determines perspective: sender == me → I sent it, else I received it.
+    """
+
+    created_at: datetime
+
+    external_id: str
+
+    recipient: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    sender: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    type: str
+
+    updated_at: datetime
+
+    content: Optional[str] = None
+
+    new: Optional[bool] = None
+
+    workspace_ext_id: Optional[str] = None
+
+
+NotificationCreateResponse: TypeAlias = List[NotificationCreateResponseItem]

arbi/types/api/notification_delete_params.py

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

arbi/types/api/notification_get_schemas_response.py

@@ -0,0 +1,197 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal, TypeAlias
+
+from ..._models import BaseModel
+from .user_response import UserResponse
+
+__all__ = [
+    "NotificationGetSchemasResponse",
+    "ClientMessage",
+    "ServerMessage",
+    "ServerMessageAuthResultMessage",
+    "ServerMessageConnectionClosedMessage",
+    "ServerMessagePresenceUpdateMessage",
+    "ServerMessageErrorMessage",
+    "ServerMessageTaskUpdateMessage",
+    "ServerMessageUserMessageNotification",
+    "ServerMessageWorkspaceShareNotification",
+    "ServerMessageContactAcceptedNotification",
+]
+
+
+class ClientMessage(BaseModel):
+    """Client authentication message."""
+
+    token: str
+
+    type: Optional[Literal["auth"]] = None
+
+
+class ServerMessageAuthResultMessage(BaseModel):
+    """Server response to authentication."""
+
+    success: bool
+
+    reason: Optional[str] = None
+
+    type: Optional[Literal["auth_result"]] = None
+
+
+class ServerMessageConnectionClosedMessage(BaseModel):
+    """Sent when connection is closed (e.g., another tab opened)."""
+
+    message: str
+
+    type: Optional[Literal["connection_closed"]] = None
+
+
+class ServerMessagePresenceUpdateMessage(BaseModel):
+    """Sent when a contact's online status changes or is no longer tracked."""
+
+    status: Literal["online", "unknown"]
+
+    timestamp: str
+
+    user_id: str
+
+    type: Optional[Literal["presence_update"]] = None
+
+
+class ServerMessageErrorMessage(BaseModel):
+    """Sent when server fails to process a client message."""
+
+    message: str
+
+    type: Optional[Literal["error"]] = None
+
+
+class ServerMessageTaskUpdateMessage(BaseModel):
+    """Document processing progress update."""
+
+    doc_ext_id: str
+
+    file_name: str
+
+    progress: int
+
+    status: Literal["queued", "processing", "completed", "failed"]
+
+    workspace_ext_id: str
+
+    type: Optional[Literal["task_update"]] = None
+
+
+class ServerMessageUserMessageNotification(BaseModel):
+    """E2E encrypted message (bilateral).
+
+    One row, both parties see it via RLS.
+    Client: sender == me → I sent it, else I received it.
+    """
+
+    content: str
+
+    created_at: datetime
+
+    external_id: str
+
+    new: bool
+
+    recipient: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    sender: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    updated_at: datetime
+
+    type: Optional[Literal["user_message"]] = None
+
+
+class ServerMessageWorkspaceShareNotification(BaseModel):
+    """Workspace shared (bilateral).
+
+    One row, both parties see it via RLS.
+    """
+
+    created_at: datetime
+
+    external_id: str
+
+    new: bool
+
+    recipient: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    sender: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    updated_at: datetime
+
+    workspace_ext_id: str
+
+    type: Optional[Literal["workspace_share"]] = None
+
+
+class ServerMessageContactAcceptedNotification(BaseModel):
+    """Contact invitation accepted.
+
+    Sent to inviter when their invited contact registers.
+    sender = new user who registered, recipient = inviter.
+    """
+
+    created_at: datetime
+
+    external_id: str
+
+    new: bool
+
+    recipient: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    sender: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    updated_at: datetime
+
+    type: Optional[Literal["contact_accepted"]] = None
+
+
+ServerMessage: TypeAlias = Union[
+    ServerMessageAuthResultMessage,
+    ServerMessageConnectionClosedMessage,
+    ServerMessagePresenceUpdateMessage,
+    ServerMessageErrorMessage,
+    ServerMessageTaskUpdateMessage,
+    ServerMessageUserMessageNotification,
+    ServerMessageWorkspaceShareNotification,
+    ServerMessageContactAcceptedNotification,
+]
+
+
+class NotificationGetSchemasResponse(BaseModel):
+    """Container for all WebSocket message schemas."""
+
+    client_messages: Optional[List[ClientMessage]] = None
+
+    server_messages: Optional[List[ServerMessage]] = None

arbi/types/api/notification_list_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+from .user_response import UserResponse
+
+__all__ = ["NotificationListResponse", "NotificationListResponseItem"]
+
+
+class NotificationListResponseItem(BaseModel):
+    """Notification response model for API and WebSocket.
+
+    Bilateral: both sender and recipient see the same row.
+    Client determines perspective: sender == me → I sent it, else I received it.
+    """
+
+    created_at: datetime
+
+    external_id: str
+
+    recipient: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    sender: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    type: str
+
+    updated_at: datetime
+
+    content: Optional[str] = None
+
+    new: Optional[bool] = None
+
+    workspace_ext_id: Optional[str] = None
+
+
+NotificationListResponse: TypeAlias = List[NotificationListResponseItem]

arbi/types/api/notification_update_params.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable, Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["NotificationUpdateParams", "Update"]
+
+
+class NotificationUpdateParams(TypedDict, total=False):
+    updates: Required[Iterable[Update]]
+
+
+class Update(TypedDict, total=False):
+    """Single notification update for bulk PATCH.
+
+    Supports two operations:
+    - content: Re-encrypt content (key rotation)
+    - read: Mark as read (only recipient can do this)
+    """
+
+    external_id: Required[str]
+
+    content: Optional[str]
+
+    read: Optional[bool]

arbi/types/api/notification_update_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import TypeAlias
+
+from ..._models import BaseModel
+from .user_response import UserResponse
+
+__all__ = ["NotificationUpdateResponse", "NotificationUpdateResponseItem"]
+
+
+class NotificationUpdateResponseItem(BaseModel):
+    """Notification response model for API and WebSocket.
+
+    Bilateral: both sender and recipient see the same row.
+    Client determines perspective: sender == me → I sent it, else I received it.
+    """
+
+    created_at: datetime
+
+    external_id: str
+
+    recipient: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    sender: UserResponse
+    """Standard user representation used across all endpoints.
+
+    Used for: login response, workspace users, contacts (when registered).
+    """
+
+    type: str
+
+    updated_at: datetime
+
+    content: Optional[str] = None
+
+    new: Optional[bool] = None
+
+    workspace_ext_id: Optional[str] = None
+
+
+NotificationUpdateResponse: TypeAlias = List[NotificationUpdateResponseItem]

arbi/types/api/parser_config_param.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypeAlias
+
+__all__ = ["ParserConfigParam"]
+
+ParserConfigParam: TypeAlias = object

arbi/types/api/query_llm_config.py

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["QueryLlmConfig"]
+
+
+class QueryLlmConfig(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_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)
+    """The system instruction string."""
+
+    temperature: Optional[float] = FieldInfo(alias="TEMPERATURE", default=None)
+    """Temperature value for randomness."""

arbi/types/api/query_llm_config_param.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["QueryLlmConfigParam"]
+
+
+class QueryLlmConfigParam(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_tokens: Annotated[int, PropertyInfo(alias="MAX_TOKENS")]
+    """Maximum number of tokens allowed."""
+
+    model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
+    """The name of the non-reasoning model to be used."""
+
+    system_instruction: Annotated[str, PropertyInfo(alias="SYSTEM_INSTRUCTION")]
+    """The system instruction string."""
+
+    temperature: Annotated[float, PropertyInfo(alias="TEMPERATURE")]
+    """Temperature value for randomness."""

arbi/types/api/reranker_config.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["RerankerConfig"]
+
+
+class RerankerConfig(BaseModel):
+    api_type: Optional[Literal["local", "remote"]] = FieldInfo(alias="API_TYPE", default=None)
+    """The inference type (local or remote)."""
+
+    max_numb_of_chunks: Optional[int] = FieldInfo(alias="MAX_NUMB_OF_CHUNKS", default=None)
+    """Maximum number of chunks to return after reranking."""
+
+    api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
+    """Name of the reranking model to use."""

arbi/types/api/reranker_config_param.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["RerankerConfigParam"]
+
+
+class RerankerConfigParam(TypedDict, total=False):
+    api_type: Annotated[Literal["local", "remote"], PropertyInfo(alias="API_TYPE")]
+    """The inference type (local or remote)."""
+
+    max_numb_of_chunks: Annotated[int, PropertyInfo(alias="MAX_NUMB_OF_CHUNKS")]
+    """Maximum number of chunks to return after reranking."""
+
+    model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
+    """Name of the reranking model to use."""

arbi/types/api/retriever_config.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["RetrieverConfig"]
+
+
+class RetrieverConfig(BaseModel):
+    group_size: Optional[int] = FieldInfo(alias="GROUP_SIZE", default=None)
+    """Maximum number of chunks per document for retrieval."""
+
+    hybrid_dense_weight: Optional[float] = FieldInfo(alias="HYBRID_DENSE_WEIGHT", default=None)
+    """Weight for dense vectors in hybrid mode"""
+
+    hybrid_reranker_weight: Optional[float] = FieldInfo(alias="HYBRID_RERANKER_WEIGHT", default=None)
+    """Weight for reranker score in hybrid mode score blending (0-1).
+
+    RRF weight = 1 - this value
+    """
+
+    hybrid_sparse_weight: Optional[float] = FieldInfo(alias="HYBRID_SPARSE_WEIGHT", default=None)
+    """Weight for sparse vectors in hybrid mode"""
+
+    max_distinct_documents: Optional[int] = FieldInfo(alias="MAX_DISTINCT_DOCUMENTS", default=None)
+    """Maximum number of distinct documents to search for."""
+
+    max_total_chunks_to_retrieve: Optional[int] = FieldInfo(alias="MAX_TOTAL_CHUNKS_TO_RETRIEVE", default=None)
+    """Maximum total number of chunks to retrieve for all documents retrieved."""
+
+    min_retrieval_sim_score: Optional[float] = FieldInfo(alias="MIN_RETRIEVAL_SIM_SCORE", default=None)
+    """Minimum similarity score for retrieval of a chunk."""
+
+    search_mode: Optional[Literal["semantic", "keyword", "hybrid"]] = FieldInfo(alias="SEARCH_MODE", default=None)
+    """Search mode: semantic (dense), keyword (sparse), or hybrid"""

arbi/types/api/retriever_config_param.py

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["RetrieverConfigParam"]
+
+
+class RetrieverConfigParam(TypedDict, total=False):
+    group_size: Annotated[int, PropertyInfo(alias="GROUP_SIZE")]
+    """Maximum number of chunks per document for retrieval."""
+
+    hybrid_dense_weight: Annotated[float, PropertyInfo(alias="HYBRID_DENSE_WEIGHT")]
+    """Weight for dense vectors in hybrid mode"""
+
+    hybrid_reranker_weight: Annotated[float, PropertyInfo(alias="HYBRID_RERANKER_WEIGHT")]
+    """Weight for reranker score in hybrid mode score blending (0-1).
+
+    RRF weight = 1 - this value
+    """
+
+    hybrid_sparse_weight: Annotated[float, PropertyInfo(alias="HYBRID_SPARSE_WEIGHT")]
+    """Weight for sparse vectors in hybrid mode"""
+
+    max_distinct_documents: Annotated[int, PropertyInfo(alias="MAX_DISTINCT_DOCUMENTS")]
+    """Maximum number of distinct documents to search for."""
+
+    max_total_chunks_to_retrieve: Annotated[int, PropertyInfo(alias="MAX_TOTAL_CHUNKS_TO_RETRIEVE")]
+    """Maximum total number of chunks to retrieve for all documents retrieved."""
+
+    min_retrieval_sim_score: Annotated[float, PropertyInfo(alias="MIN_RETRIEVAL_SIM_SCORE")]
+    """Minimum similarity score for retrieval of a chunk."""
+
+    search_mode: Annotated[Literal["semantic", "keyword", "hybrid"], PropertyInfo(alias="SEARCH_MODE")]
+    """Search mode: semantic (dense), keyword (sparse), or hybrid"""

arbi/types/api/tag_create_params.py

@@ -0,0 +1,49 @@
+# 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 Literal, Required, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["TagCreateParams", "TagType"]
+
+
+class TagCreateParams(TypedDict, total=False):
+    name: Required[str]
+
+    workspace_ext_id: Required[str]
+
+    instruction: Optional[str]
+
+    parent_ext_id: Optional[str]
+
+    shared: Optional[bool]
+
+    tag_type: TagType
+    """Tag format configuration stored as JSONB.
+
+    Type-specific fields:
+
+    - select: options (list of choices, can be single or multi-select)
+    - search: tag name is the query, chunks include relevance scores
+    - checkbox, text, number, folder: type only
+    """
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]
+
+
+class TagType(TypedDict, total=False):
+    """Tag format configuration stored as JSONB.
+
+    Type-specific fields:
+    - select: options (list of choices, can be single or multi-select)
+    - search: tag name is the query, chunks include relevance scores
+    - checkbox, text, number, folder: type only
+    """
+
+    options: SequenceNotStr[str]
+
+    type: Literal["checkbox", "text", "number", "select", "folder", "search"]

arbi/types/api/tag_create_response.py

@@ -0,0 +1,57 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["TagCreateResponse", "TagType"]
+
+
+class TagType(BaseModel):
+    """Tag format configuration stored as JSONB.
+
+    Type-specific fields:
+    - select: options (list of choices, can be single or multi-select)
+    - search: tag name is the query, chunks include relevance scores
+    - checkbox, text, number, folder: type only
+    """
+
+    options: Optional[List[str]] = None
+
+    type: Optional[Literal["checkbox", "text", "number", "select", "folder", "search"]] = None
+
+
+class TagCreateResponse(BaseModel):
+    created_at: datetime
+
+    created_by_ext_id: str
+
+    doctag_count: int
+
+    external_id: str
+
+    name: str
+
+    shared: bool
+
+    tag_type: TagType
+    """Tag format configuration stored as JSONB.
+
+    Type-specific fields:
+
+    - select: options (list of choices, can be single or multi-select)
+    - search: tag name is the query, chunks include relevance scores
+    - checkbox, text, number, folder: type only
+    """
+
+    updated_at: datetime
+
+    workspace_ext_id: str
+
+    instruction: Optional[str] = None
+
+    parent_ext_id: Optional[str] = None
+
+    updated_by_ext_id: Optional[str] = None