cocoindex 0.3.4__cp311-abi3-manylinux_2_28_x86_64.whl

cocoindex/__init__.py

@@ -0,0 +1,114 @@
+"""
+Cocoindex is a framework for building and running indexing pipelines.
+"""
+
+from . import _engine  # type: ignore
+from . import functions, sources, targets, cli, utils
+
+from . import targets as storages  # Deprecated: Use targets instead
+
+from .auth_registry import (
+    AuthEntryReference,
+    add_auth_entry,
+    add_transient_auth_entry,
+    ref_auth_entry,
+)
+from .flow import FlowBuilder, DataScope, DataSlice, Flow, transform_flow
+from .flow import flow_def
+from .flow import EvaluateAndDumpOptions, GeneratedField
+from .flow import FlowLiveUpdater, FlowLiveUpdaterOptions, FlowUpdaterStatusUpdates
+from .flow import open_flow
+from .flow import add_flow_def, remove_flow  # DEPRECATED
+from .flow import update_all_flows_async, setup_all_flows, drop_all_flows
+from .lib import settings, init, start_server, stop
+from .llm import LlmSpec, LlmApiType
+from .index import (
+    VectorSimilarityMetric,
+    VectorIndexDef,
+    IndexOptions,
+    HnswVectorIndexMethod,
+    IvfFlatVectorIndexMethod,
+)
+from .setting import DatabaseConnectionSpec, Settings, ServerSettings
+from .setting import get_app_namespace
+from .query_handler import QueryHandlerResultFields, QueryInfo, QueryOutput
+from .typing import (
+    Int64,
+    Float32,
+    Float64,
+    LocalDateTime,
+    OffsetDateTime,
+    Range,
+    Vector,
+    Json,
+)
+
+_engine.init_pyo3_runtime()
+
+__all__ = [
+    # Submodules
+    "_engine",
+    "functions",
+    "llm",
+    "sources",
+    "targets",
+    "storages",
+    "cli",
+    "op",
+    "utils",
+    # Auth registry
+    "AuthEntryReference",
+    "add_auth_entry",
+    "add_transient_auth_entry",
+    "ref_auth_entry",
+    # Flow
+    "FlowBuilder",
+    "DataScope",
+    "DataSlice",
+    "Flow",
+    "transform_flow",
+    "flow_def",
+    "EvaluateAndDumpOptions",
+    "GeneratedField",
+    "FlowLiveUpdater",
+    "FlowLiveUpdaterOptions",
+    "FlowUpdaterStatusUpdates",
+    "open_flow",
+    "add_flow_def",  # DEPRECATED
+    "remove_flow",  # DEPRECATED
+    "update_all_flows_async",
+    "setup_all_flows",
+    "drop_all_flows",
+    # Lib
+    "settings",
+    "init",
+    "start_server",
+    "stop",
+    # LLM
+    "LlmSpec",
+    "LlmApiType",
+    # Index
+    "VectorSimilarityMetric",
+    "VectorIndexDef",
+    "IndexOptions",
+    "HnswVectorIndexMethod",
+    "IvfFlatVectorIndexMethod",
+    # Settings
+    "DatabaseConnectionSpec",
+    "Settings",
+    "ServerSettings",
+    "get_app_namespace",
+    # Typing
+    "Int64",
+    "Float32",
+    "Float64",
+    "LocalDateTime",
+    "OffsetDateTime",
+    "Range",
+    "Vector",
+    "Json",
+    # Query handler
+    "QueryHandlerResultFields",
+    "QueryInfo",
+    "QueryOutput",
+]

cocoindex/auth_registry.py

@@ -0,0 +1,44 @@
+"""
+Auth registry is used to register and reference auth entries.
+"""
+
+from dataclasses import dataclass
+from typing import Generic, TypeVar
+
+from . import _engine  # type: ignore
+from .engine_object import dump_engine_object, load_engine_object
+
+T = TypeVar("T")
+
+
+@dataclass
+class TransientAuthEntryReference(Generic[T]):
+    """Reference an auth entry, may or may not have a stable key."""
+
+    key: str
+
+
+class AuthEntryReference(TransientAuthEntryReference[T]):
+    """Reference an auth entry, with a key stable across ."""
+
+
+def add_transient_auth_entry(value: T) -> TransientAuthEntryReference[T]:
+    """Add an auth entry to the registry. Returns its reference."""
+    key = _engine.add_transient_auth_entry(dump_engine_object(value))
+    return TransientAuthEntryReference(key)
+
+
+def add_auth_entry(key: str, value: T) -> AuthEntryReference[T]:
+    """Add an auth entry to the registry. Returns its reference."""
+    _engine.add_auth_entry(key, dump_engine_object(value))
+    return AuthEntryReference(key)
+
+
+def ref_auth_entry(key: str) -> AuthEntryReference[T]:
+    """Reference an auth entry by its key."""
+    return AuthEntryReference(key)
+
+
+def get_auth_entry(cls: type[T], ref: TransientAuthEntryReference[T]) -> T:
+    """Get an auth entry by its key."""
+    return load_engine_object(cls, _engine.get_auth_entry(ref.key))