knowledge2 0.4.0__py3-none-any.whl

sdk/types/auth.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+from typing import List, NotRequired, Optional, TypedDict
+
+
+class ApiKeyCreateResponse(TypedDict):
+    id: str
+    org_id: str
+    name: str
+    api_key: str
+
+
+class ApiKeyRotateResponse(TypedDict):
+    id: str
+    org_id: str
+    name: str
+    api_key: str
+
+
+class ApiKeyRevokeResponse(TypedDict):
+    id: str
+    revoked: bool
+
+
+class ApiKeyListItem(TypedDict, total=False):
+    id: str
+    org_id: str
+    org_name: str | None
+    name: str
+    scopes: dict
+    project_names: list[str]
+    revoked: bool
+    created_at: str | None
+    last_used_at: str | None
+
+
+class ApiKeyListResponse(TypedDict):
+    keys: list[ApiKeyListItem]
+
+
+class WhoAmIResponse(TypedDict):
+    org_id: str
+    api_key_id: str
+    name: str
+    features: NotRequired[dict[str, bool]]

sdk/types/chunks.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from typing import List, Optional, TypedDict
+
+
+class ChunkListItem(TypedDict, total=False):
+    id: str
+    text: str
+    custom_metadata: dict
+    system_metadata: dict
+    offset_start: int | None
+    offset_end: int | None
+    page_start: int | None
+    page_end: int | None
+
+
+class ChunkListResponse(TypedDict):
+    chunks: list[ChunkListItem]

sdk/types/common.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from typing import Any, TypedDict
+
+
+class ApiErrorDetail(TypedDict, total=False):
+    code: str
+    message: str
+    details: Any
+    request_id: str

sdk/types/console.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+from typing import Any, TypedDict
+
+from .jobs import JobListItem
+
+
+class ConsoleMeResponse(TypedDict, total=False):
+    provisioned: bool
+    org_id: str | None
+    org_name: str | None
+    project_id: str | None
+    project_name: str | None
+    role: str | None
+    is_org_admin: bool
+    auth_subject: str | None
+    user_id: str | None
+    email: str | None
+    name: str | None
+
+
+class ConsoleBootstrapResponse(ConsoleMeResponse, total=False):
+    created: bool
+
+
+class ConsoleSummaryResponse(TypedDict):
+    corpora_total: int
+    documents_total: int
+    documents_failed: int
+    recent_jobs: list[JobListItem]
+
+
+class ConsoleProjectItem(TypedDict, total=False):
+    id: str
+    name: str
+    org_id: str
+    role: str
+
+
+class ConsoleProjectListResponse(TypedDict):
+    projects: list[ConsoleProjectItem]
+
+
+class ConsoleOrgResponse(TypedDict, total=False):
+    id: str
+    name: str
+    contact_email: str | None
+
+
+class TeamMember(TypedDict, total=False):
+    membership_id: str
+    user_id: str
+    email: str | None
+    name: str | None
+    role: str
+    created_at: str | None
+    is_current_user: bool
+
+
+class TeamListResponse(TypedDict):
+    members: list[TeamMember]
+
+
+class InviteListItem(TypedDict, total=False):
+    id: str
+    email: str
+    role: str
+    created_at: str | None
+    expires_at: str | None
+    accepted_at: str | None
+
+
+class InviteListResponse(TypedDict):
+    invites: list[InviteListItem]
+
+
+class InviteCreateResponse(TypedDict, total=False):
+    id: str
+    email: str
+    role: str
+    token: str
+    expires_at: str | None
+
+
+class InviteAcceptResponse(TypedDict, total=False):
+    org_id: str
+    org_name: str | None
+    project_id: str
+    project_name: str | None
+    role: str
+
+
+class MemberUpdateResponse(TypedDict):
+    updated: bool
+    role: str
+
+
+class MemberRemoveResponse(TypedDict):
+    removed: bool

sdk/types/corpora.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from typing import Any, Dict, List, Optional, TypedDict
+
+
+class CorpusResponse(TypedDict, total=False):
+    id: str
+    project_id: str
+    name: str
+    description: str | None
+    is_tutorial: bool
+    is_demo: bool
+    current_model_id: str | None
+    created_at: str | None
+    org_name: str | None
+    project_name: str | None
+    chunking_config: dict[str, Any] | None
+
+
+class CorpusListResponse(TypedDict):
+    corpora: list[CorpusResponse]
+    total: int
+
+
+class CorpusDeleteResponse(TypedDict, total=False):
+    message: str
+    counts: dict[str, int]
+
+
+class CorpusStatusResponse(TypedDict, total=False):
+    status: str
+    search_status: str
+    retrieval_ready: bool
+    retrieval_status: str | None
+    ingesting: bool
+    indexing: bool
+    document_count: int
+    documents_processing: int
+    documents_failed: int
+    documents_failed_ratio: float
+    dense_status: str | None
+    sparse_status: str | None

sdk/types/deployments.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from typing import Optional, TypedDict
+
+
+class DeploymentResponse(TypedDict, total=False):
+    id: str
+    corpus_id: str
+    model_id: str
+    traffic_pct: int
+    reindex_job_id: str | None

sdk/types/documents.py

@@ -0,0 +1,104 @@
+from __future__ import annotations
+
+from typing import Literal, TypedDict
+
+
+class ChunkingConfig(TypedDict, total=False):
+    """Chunking configuration for document ingestion.
+
+    All fields are optional. Unset fields inherit from corpus defaults or
+    application-owned defaults in the worker.
+    """
+
+    # Top-level chunking strategy
+    strategy: Literal["fixed", "paragraph", "semantic", "semchunk", "unstructured", "docling"]
+    # Unstructured sub-strategy (only used when strategy="unstructured")
+    chunking_strategy: Literal["basic", "by_title", "by_page", "by_similarity"]
+    # Max characters per chunk
+    chunk_size: int
+    # Overlap between chunks (characters)
+    overlap: int
+    # Combine small sections under N chars (by_title specific)
+    combine_text_under_n_chars: int
+    # Allow sections to span pages
+    multipage_sections: bool
+    # Soft limit before hard max (new_after_n_chars)
+    new_after_n_chars: int
+    # Concurrent Unstructured API requests
+    max_concurrent_requests: int
+    # API timeout in milliseconds
+    timeout: int
+    # Near-duplicate handling for chunk insertion
+    dedup_mode: Literal["off", "minhash"]
+    dedup_partition_keys: list[str]
+
+    # Docling-specific fields (only used when strategy="docling")
+    docling_chunker_type: Literal["hybrid", "hierarchical"]
+    docling_tokenizer_model: str
+    docling_max_tokens: int
+    docling_merge_peers: bool
+    docling_merge_list_items: bool
+    docling_processing_mode: Literal["auto", "sequential", "batch"]
+    docling_accelerator: Literal["auto", "cuda", "cpu"]
+
+
+class DocumentCreateResponse(TypedDict):
+    id: str
+    job_id: str
+
+
+class DocumentBatchItem(TypedDict, total=False):
+    source_uri: str | None
+    raw_text: str
+    metadata: dict | None
+
+
+class DocumentUrlItem(TypedDict, total=False):
+    url: str
+    title: str | None
+    tags: list[str] | None
+    metadata: dict | None
+
+
+class DocumentUrlIngestResponse(TypedDict):
+    job_id: str
+    submitted: int
+
+
+class DocumentManifestIngestResponse(TypedDict):
+    job_id: str
+
+
+class DocumentListItem(TypedDict, total=False):
+    id: str
+    corpus_id: str
+    source_uri: str
+    custom_metadata: dict
+    system_metadata: dict
+    created_at: str | None
+    status: str | None
+    size_bytes: int | None
+    content_type: str | None
+    preview: str | None
+
+
+class DocumentListResponse(TypedDict):
+    documents: list[DocumentListItem]
+    total: int
+
+
+class DocumentDetailResponse(DocumentListItem):
+    pass
+
+
+class DocumentDeleteResponse(TypedDict, total=False):
+    message: str
+    reindex_job_id: str | None
+
+
+class DocumentBatchUploadResponse(TypedDict):
+    """Response for multipart batch file upload."""
+
+    job_id: str
+    doc_ids: list[str]
+    count: int

sdk/types/embeddings.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import List, TypedDict
+
+
+class EmbeddingItem(TypedDict):
+    embedding: list[float]
+    index: int
+
+
+class EmbeddingsResponse(TypedDict):
+    data: list[EmbeddingItem]
+    model: str
+
+
+class EmbeddingModelInfo(TypedDict):
+    model_name: str
+    is_default: bool
+
+
+class EmbeddingModelListResponse(TypedDict):
+    models: list[EmbeddingModelInfo]

sdk/types/evaluation.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from typing import TypedDict
+
+
+class EvalRunResponse(TypedDict):
+    eval_id: str
+    status: str
+    job_id: str
+
+
+class EvalRunDetailResponse(TypedDict, total=False):
+    eval_id: str
+    status: str
+    metrics: dict

sdk/types/feedback.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from typing import TypedDict
+
+
+class FeedbackResponse(TypedDict):
+    message: str

sdk/types/feeds.py

@@ -0,0 +1,61 @@
+from __future__ import annotations
+
+from typing import Any, TypedDict
+
+
+class FeedSubscriptionResponse(TypedDict, total=False):
+    """A subscription entry within a feed response."""
+
+    id: str | None
+    agent_id: str
+    agent_name: str | None
+    role: str
+
+
+class FeedResponse(TypedDict, total=False):
+    """A single knowledge feed record."""
+
+    id: str
+    project_id: str
+    agent_id: str | None
+    name: str
+    query: str
+    persistent: bool
+    reactive: bool
+    target_corpus_id: str | None
+    schedule_interval: str | None
+    schedule_hour: int | None
+    start_from: str | None
+    top_k: int | None
+    metadata_filters: dict[str, Any] | None
+    activation_status: str
+    last_checked_seq: int
+    last_run_at: str | None
+    last_run_result_count: int | None
+    subscriptions: list[FeedSubscriptionResponse]
+    parent_feed_id: str | None
+    has_draft: bool
+    created_at: str | None
+    updated_at: str | None
+
+
+class FeedListResponse(TypedDict):
+    """Paginated list of feeds."""
+
+    feeds: list[FeedResponse]
+    total: int
+    limit: int
+    offset: int
+
+
+class FeedRunResponse(TypedDict, total=False):
+    """Response from triggering a feed run."""
+
+    new_content: bool
+    results: list[dict[str, Any]] | None
+    result_count: int
+    truncated: bool
+    ingestion_job_id: str | None
+    dry_run: bool
+    would_ingest_count: int | None
+    feed_run_id: str | None

sdk/types/indexes.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+
+from typing import Any, List, Optional, TypedDict
+
+
+class IndexBuildResponse(TypedDict):
+    job_id: str
+    index_ids: list[str]
+
+
+class IndexStatusResponse(TypedDict, total=False):
+    build_set_id: str | None
+    requested_mode: str | None
+    effective_mode: str | None
+    start_change_seq_exclusive: int | None
+    end_change_seq_inclusive: int | None
+    retrieval_status: str | None
+    retrieval_reason: str | None
+    document_count: int | None
+    dense_status: str | None
+    sparse_status: str | None
+    sparse_metadata_status: str | None
+    dense_reason: str | None
+    sparse_reason: str | None
+    sparse_metadata_reason: str | None
+
+
+class IndexCompactResponse(TypedDict, total=False):
+    archived: Any
+    keep: int

sdk/types/jobs.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from typing import List, Optional, TypedDict
+
+
+class JobActions(TypedDict, total=False):
+    can_cancel: bool
+    can_retry: bool
+
+
+class JobResponse(TypedDict, total=False):
+    id: str
+    job_type: str
+    status: str
+    actions: JobActions
+    payload: dict
+    result: dict
+    error_message: str | None
+    created_at: str | None
+    updated_at: str | None
+    heartbeat_at: str | None
+    requeue_count: int | None
+    run_after: str | None
+
+
+class JobListItem(TypedDict, total=False):
+    id: str
+    job_type: str
+    status: str
+    actions: JobActions
+    payload: dict
+    result: dict
+    error_message: str | None
+    created_at: str | None
+    updated_at: str | None
+    heartbeat_at: str | None
+    requeue_count: int | None
+    run_after: str | None
+
+
+class JobListResponse(TypedDict):
+    jobs: list[JobListItem]
+
+
+class JobStatusResponse(TypedDict):
+    status: str
+
+
+class ReconcileJobsResponse(TypedDict):
+    reconciled: int

sdk/types/models.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import Any, Dict, List, TypedDict
+
+
+class ModelResponse(TypedDict, total=False):
+    id: str
+    corpus_id: str
+    base_model: str
+    embedding_dim: int
+    max_seq_length: int
+    version: int
+    created_at: str
+
+
+class ModelListResponse(TypedDict):
+    models: list[ModelResponse]
+
+
+class ModelDeleteResponse(TypedDict, total=False):
+    message: str
+    counts: dict[str, Any]