arbi 0.1.0__py3-none-any.whl

arbi/types/api/document/annotation_update_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 import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["AnnotationUpdateParams"]
+
+
+class AnnotationUpdateParams(TypedDict, total=False):
+    doc_ext_id: Required[str]
+
+    note: Optional[str]
+
+    page_ref: Optional[int]

arbi/types/api/document/doc_tag_response.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import datetime
+
+from ...._models import BaseModel
+
+__all__ = ["DocTagResponse"]
+
+
+class DocTagResponse(BaseModel):
+    created_at: datetime
+
+    created_by_ext_id: str
+
+    doc_ext_id: str
+
+    doctag_ext_id: str
+
+    tag_ext_id: str
+
+    updated_at: datetime
+
+    note: Optional[str] = None
+
+    page_ref: Optional[int] = None

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_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 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_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 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_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__ = ["DocumentDeleteResponse"]
+
+
+class DocumentDeleteResponse(BaseModel):
+    detail: Optional[str] = None

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_get_tags_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 .document.doc_tag_response import DocTagResponse
+
+__all__ = ["DocumentGetTagsResponse"]
+
+DocumentGetTagsResponse: TypeAlias = List[DocTagResponse]

arbi/types/api/document_update_params.py

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import date
+from typing_extensions import Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["DocumentUpdateParams"]
+
+
+class DocumentUpdateParams(TypedDict, total=False):
+    doc_date: Annotated[Union[str, date, None], PropertyInfo(format="iso8601")]
+
+    shared: Optional[bool]
+
+    title: Optional[str]

arbi/types/api/document_update_response.py

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from datetime import date
+
+from ..._models import BaseModel
+
+__all__ = ["DocumentUpdateResponse"]
+
+
+class DocumentUpdateResponse(BaseModel):
+    external_id: str
+
+    success: bool
+
+    title: str
+
+    detail: Optional[str] = None
+
+    doc_date: Optional[date] = None
+
+    shared: Optional[bool] = None

arbi/types/api/document_upload_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 List, Optional
+from typing_extensions import Required, TypedDict
+
+from ..._types import FileTypes
+
+__all__ = ["DocumentUploadParams"]
+
+
+class DocumentUploadParams(TypedDict, total=False):
+    workspace_ext_id: Required[str]
+
+    files: Required[List[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"""

arbi/types/api/document_view_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 import Optional
+from typing_extensions import TypedDict
+
+__all__ = ["DocumentViewParams"]
+
+
+class DocumentViewParams(TypedDict, total=False):
+    page: Optional[int]
+    """Optional page to open on load"""

arbi/types/api/embedder_config.py

@@ -0,0 +1,18 @@
+# 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)."""
+
+    api_model_name: Optional[str] = FieldInfo(alias="MODEL_NAME", default=None)
+    """The name of the embedder model."""

arbi/types/api/embedder_config_param.py

@@ -0,0 +1,17 @@
+# 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)."""
+
+    model_name: Annotated[str, PropertyInfo(alias="MODEL_NAME")]
+    """The name of the embedder model."""

arbi/types/api/health_check_app_response.py

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

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_check_services_response.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from ..._models import BaseModel
+
+__all__ = ["HealthCheckServicesResponse", "Service"]
+
+
+class Service(BaseModel):
+    name: str
+
+    status: str
+
+    detail: Optional[str] = None
+
+    service_info: Optional[Dict[str, object]] = None
+
+
+class HealthCheckServicesResponse(BaseModel):
+    services: List[Service]
+
+    application: Optional[str] = None

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/model_citation_config.py

@@ -0,0 +1,23 @@
+# 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_model_name: Optional[str] = FieldInfo(alias="SIM_MODEL_NAME", default=None)
+    """Name of the model to be used."""
+
+    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,23 @@
+# 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_model_name: Annotated[str, PropertyInfo(alias="SIM_MODEL_NAME")]
+    """Name of the model to be used."""
+
+    sim_threashold: Annotated[float, PropertyInfo(alias="SIM_THREASHOLD")]
+    """How similar does the statement needs to be to be considered as citation."""

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 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 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,23 @@
+# 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__ = ["RetrieverConfig"]
+
+
+class RetrieverConfig(BaseModel):
+    group_size: Optional[int] = FieldInfo(alias="GROUP_SIZE", default=None)
+    """Maximum number of chunks per document for retrieval."""
+
+    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."""

arbi/types/api/retriever_config_param.py

@@ -0,0 +1,23 @@
+# 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__ = ["RetrieverConfigParam"]
+
+
+class RetrieverConfigParam(TypedDict, total=False):
+    group_size: Annotated[int, PropertyInfo(alias="GROUP_SIZE")]
+    """Maximum number of chunks per document for retrieval."""
+
+    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."""

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

arbi/types/api/sso_invite_response.py

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

arbi/types/api/sso_login_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 import Optional
+from typing_extensions import Required, TypedDict
+
+__all__ = ["SSOLoginParams"]
+
+
+class SSOLoginParams(TypedDict, total=False):
+    token: Required[str]
+
+    email: Required[str]
+
+    passcode: Optional[str]

arbi/types/api/sso_login_response.py

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

arbi/types/api/sso_rotate_passcode_response.py

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

arbi/types/api/tag_apply_to_docs_params.py

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

arbi/types/api/tag_apply_to_docs_response.py

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