arbi 0.18.0__py3-none-any.whl

arbi/types/api/document/doc_tag_response.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+
+from ...._models import BaseModel
+
+__all__ = ["DocTagResponse", "Citations"]
+
+
+class Citations(BaseModel):
+    """Data for a single citation - shared by DocTags and ModelCitationTool."""
+
+    chunk_ids: List[str]
+
+    offset_end: int
+
+    offset_start: int
+
+    statement: str
+
+
+class DocTagResponse(BaseModel):
+    """Response for doctag operations - the link between a document and a tag."""
+
+    created_at: datetime
+
+    created_by_ext_id: str
+
+    doc_ext_id: str
+
+    tag_ext_id: str
+
+    updated_at: datetime
+
+    citations: Optional[Dict[str, Citations]] = None
+
+    note: Optional[str] = None
+
+    updated_by_ext_id: Optional[str] = None

arbi/types/api/document/doctag_create_params.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._types import SequenceNotStr
+from ...._utils import PropertyInfo
+
+__all__ = ["DoctagCreateParams", "Citations"]
+
+
+class DoctagCreateParams(TypedDict, total=False):
+    doc_ext_ids: Required[SequenceNotStr[str]]
+
+    tag_ext_id: Required[str]
+
+    citations: Optional[Dict[str, Citations]]
+
+    note: Optional[str]
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]
+
+
+class Citations(TypedDict, total=False):
+    """Data for a single citation - shared by DocTags and ModelCitationTool."""
+
+    chunk_ids: Required[SequenceNotStr[str]]
+
+    offset_end: Required[int]
+
+    offset_start: Required[int]
+
+    statement: Required[str]

arbi/types/api/document/doctag_create_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .doc_tag_response import DocTagResponse
+
+__all__ = ["DoctagCreateResponse"]
+
+DoctagCreateResponse: TypeAlias = List[DocTagResponse]

arbi/types/api/document/doctag_delete_params.py

@@ -0,0 +1,15 @@
+# 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__ = ["DoctagDeleteParams"]
+
+
+class DoctagDeleteParams(TypedDict, total=False):
+    doc_ext_ids: Required[SequenceNotStr[str]]
+
+    tag_ext_id: Required[str]

arbi/types/api/document/doctag_generate_params.py

@@ -0,0 +1,22 @@
+# 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, Annotated, TypedDict
+
+from ...._types import SequenceNotStr
+from ...._utils import PropertyInfo
+
+__all__ = ["DoctagGenerateParams"]
+
+
+class DoctagGenerateParams(TypedDict, total=False):
+    doc_ext_ids: Required[SequenceNotStr[str]]
+
+    tag_ext_ids: Required[SequenceNotStr[str]]
+
+    config_ext_id: Optional[str]
+    """Configuration to use for LLM"""
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]

arbi/types/api/document/doctag_generate_response.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from ...._models import BaseModel
+
+__all__ = ["DoctagGenerateResponse"]
+
+
+class DoctagGenerateResponse(BaseModel):
+    """Response for generate annotations endpoint (202 Accepted).
+
+    Returns the accepted doc and tag IDs that will be processed.
+    """
+
+    doc_ext_ids: List[str]
+    """Document IDs that will be processed"""
+
+    tag_ext_ids: List[str]
+    """Tag IDs that will be processed"""

arbi/types/api/document/doctag_update_params.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+from typing_extensions import Required, Annotated, TypedDict
+
+from ...._types import SequenceNotStr
+from ...._utils import PropertyInfo
+
+__all__ = ["DoctagUpdateParams", "Citations"]
+
+
+class DoctagUpdateParams(TypedDict, total=False):
+    doc_ext_id: Required[str]
+
+    tag_ext_id: Required[str]
+
+    citations: Optional[Dict[str, Citations]]
+
+    note: Optional[str]
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]
+
+
+class Citations(TypedDict, total=False):
+    """Data for a single citation - shared by DocTags and ModelCitationTool."""
+
+    chunk_ids: Required[SequenceNotStr[str]]
+
+    offset_end: Required[int]
+
+    offset_start: Required[int]
+
+    statement: Required[str]

arbi/types/api/document_date_extractor_llm_config.py

@@ -0,0 +1,29 @@
+# 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__ = ["DocumentDateExtractorLlmConfig"]
+
+
+class DocumentDateExtractorLlmConfig(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."""

arbi/types/api/document_date_extractor_llm_config_param.py

@@ -0,0 +1,28 @@
+# 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__ = ["DocumentDateExtractorLlmConfigParam"]
+
+
+class DocumentDateExtractorLlmConfigParam(TypedDict, total=False):
+    api_type: Annotated[Literal["local", "remote"], PropertyInfo(alias="API_TYPE")]
+    """The inference type (local or remote)."""
+
+    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 non-reasoning model to be used."""
+
+    system_instruction: Annotated[str, PropertyInfo(alias="SYSTEM_INSTRUCTION")]
+
+    temperature: Annotated[float, PropertyInfo(alias="TEMPERATURE")]
+    """Temperature value for randomness."""

arbi/types/api/document_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__ = ["DocumentDeleteParams"]
+
+
+class DocumentDeleteParams(TypedDict, total=False):
+    external_ids: Required[SequenceNotStr[str]]

arbi/types/api/document_get_parsed_response.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..chunk import Chunk
+from ..._models import BaseModel
+
+__all__ = ["DocumentGetParsedResponse", "Metadata"]
+
+
+class Metadata(BaseModel):
+    doc_ext_id: Optional[str] = None
+
+    file_name: Optional[str] = None
+
+    re_ocred: Optional[bool] = None
+
+    total_number_of_pages: Optional[int] = None
+
+
+class DocumentGetParsedResponse(BaseModel):
+    metadata: Metadata
+
+    chunks: Optional[List[Chunk]] = None
+
+    footnotes: Optional[Dict[str, str]] = None

arbi/types/api/document_retrieve_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 ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["DocumentRetrieveParams"]
+
+
+class DocumentRetrieveParams(TypedDict, total=False):
+    external_ids: Required[SequenceNotStr[str]]
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]

arbi/types/api/document_retrieve_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .doc_response import DocResponse
+
+__all__ = ["DocumentRetrieveResponse"]
+
+DocumentRetrieveResponse: TypeAlias = List[DocResponse]

arbi/types/api/document_update_params.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable, Optional
+from datetime import date
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["DocumentUpdateParams", "Document", "DocumentDocMetadata"]
+
+
+class DocumentUpdateParams(TypedDict, total=False):
+    documents: Required[Iterable[Document]]
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]
+
+
+class DocumentDocMetadata(TypedDict, total=False):
+    """Structured model for document metadata stored in JSONB column."""
+
+    doc_author: Optional[str]
+
+    doc_date: Annotated[Union[str, date, None], PropertyInfo(format="iso8601")]
+
+    doc_nature: Optional[str]
+
+    doc_subject: Optional[str]
+
+    title: Optional[str]
+
+
+class Document(TypedDict, total=False):
+    """Document update request - identifies doc and fields to update."""
+
+    external_id: Required[str]
+
+    doc_metadata: Optional[DocumentDocMetadata]
+    """Structured model for document metadata stored in JSONB column."""
+
+    shared: Optional[bool]

arbi/types/api/document_update_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .doc_response import DocResponse
+
+__all__ = ["DocumentUpdateResponse"]
+
+DocumentUpdateResponse: TypeAlias = List[DocResponse]

arbi/types/api/document_upload_from_url_params.py

@@ -0,0 +1,26 @@
+# 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, Annotated, TypedDict
+
+from ..._types import SequenceNotStr
+from ..._utils import PropertyInfo
+
+__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"""
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]

arbi/types/api/document_upload_from_url_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from ..._models import BaseModel
+
+__all__ = ["DocumentUploadFromURLResponse"]
+
+
+class DocumentUploadFromURLResponse(BaseModel):
+    """Response for document upload operations.
+
+    Returns array of document IDs in the same order as uploaded files.
+    """
+
+    doc_ext_ids: List[str]

arbi/types/api/document_upload_params.py

@@ -0,0 +1,26 @@
+# 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, Annotated, TypedDict
+
+from ..._types import FileTypes, SequenceNotStr
+from ..._utils import PropertyInfo
+
+__all__ = ["DocumentUploadParams"]
+
+
+class DocumentUploadParams(TypedDict, total=False):
+    workspace_ext_id: Required[str]
+
+    files: Required[SequenceNotStr[FileTypes]]
+    """Multiple files to upload"""
+
+    config_ext_id: Optional[str]
+    """Configuration to use for processing"""
+
+    shared: bool
+    """Whether the document should be shared with workspace members"""
+
+    workspace_key: Annotated[str, PropertyInfo(alias="workspace-key")]

arbi/types/api/document_upload_response.py

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from ..._models import BaseModel
+
+__all__ = ["DocumentUploadResponse"]
+
+
+class DocumentUploadResponse(BaseModel):
+    """Response for document upload operations.
+
+    Returns array of document IDs in the same order as uploaded files.
+    """
+
+    doc_ext_ids: List[str]

arbi/types/api/embedder_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__ = ["EmbedderConfig"]
+
+
+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

@@ -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__ = ["EmbedderConfigParam"]
+
+
+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_models_response.py

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["HealthCheckModelsResponse", "Model"]
+
+
+class Model(BaseModel):
+    model: str
+
+    status: str
+
+    detail: Optional[str] = None
+
+
+class HealthCheckModelsResponse(BaseModel):
+    application: str
+
+    models: List[Model]

arbi/types/api/health_get_models_response.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["HealthGetModelsResponse", "Model"]
+
+
+class Model(BaseModel):
+    api_type: str
+
+    api_model_name: str = FieldInfo(alias="model_name")
+
+
+class HealthGetModelsResponse(BaseModel):
+    models: List[Model]

arbi/types/api/health_retrieve_status_response.py

@@ -0,0 +1,49 @@
+# 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):
+    """
+    Consolidated health response containing all system status and version information
+    """
+
+    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/model_citation_config.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["ModelCitationConfig"]
+
+
+class ModelCitationConfig(BaseModel):
+    max_numb_citations: Optional[int] = FieldInfo(alias="MAX_NUMB_CITATIONS", default=None)
+    """Maximum number of citations to return per statement."""
+
+    min_char_size_to_answer: Optional[int] = FieldInfo(alias="MIN_CHAR_SIZE_TO_ANSWER", default=None)
+    """Minimum character length to be considered as a statement for citation."""
+
+    sim_threashold: Optional[float] = FieldInfo(alias="SIM_THREASHOLD", default=None)
+    """How similar does the statement needs to be to be considered as citation."""

arbi/types/api/model_citation_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 Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ModelCitationConfigParam"]
+
+
+class ModelCitationConfigParam(TypedDict, total=False):
+    max_numb_citations: Annotated[int, PropertyInfo(alias="MAX_NUMB_CITATIONS")]
+    """Maximum number of citations to return per statement."""
+
+    min_char_size_to_answer: Annotated[int, PropertyInfo(alias="MIN_CHAR_SIZE_TO_ANSWER")]
+    """Minimum character length to be considered as a statement for citation."""
+
+    sim_threashold: Annotated[float, PropertyInfo(alias="SIM_THREASHOLD")]
+    """How similar does the statement needs to be to be considered as citation."""

arbi/types/api/notification_create_params.py

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+__all__ = ["NotificationCreateParams", "Message"]
+
+
+class NotificationCreateParams(TypedDict, total=False):
+    messages: Required[Iterable[Message]]
+
+
+class Message(TypedDict, total=False):
+    """Single recipient for bulk message send."""
+
+    content: Required[str]
+
+    recipient_ext_id: Required[str]