knowledge2 0.4.0__py3-none-any.whl

sdk/models/auth.py

@@ -0,0 +1,49 @@
+"""Pydantic models for auth types."""
+
+from __future__ import annotations
+
+from pydantic import Field
+
+from sdk.models._base import K2BaseModel
+
+
+class ApiKeyCreateResponseModel(K2BaseModel):
+    id: str
+    org_id: str
+    name: str
+    api_key: str
+
+
+class ApiKeyRotateResponseModel(K2BaseModel):
+    id: str
+    org_id: str
+    name: str
+    api_key: str
+
+
+class ApiKeyRevokeResponseModel(K2BaseModel):
+    id: str
+    revoked: bool
+
+
+class ApiKeyListItemModel(K2BaseModel):
+    id: str | None = None
+    org_id: str | None = None
+    org_name: str | None = None
+    name: str | None = None
+    scopes: dict | None = None
+    project_names: list[str] | None = None
+    revoked: bool | None = None
+    created_at: str | None = None
+    last_used_at: str | None = None
+
+
+class ApiKeyListResponseModel(K2BaseModel):
+    keys: list[ApiKeyListItemModel]
+
+
+class WhoAmIResponseModel(K2BaseModel):
+    org_id: str
+    api_key_id: str
+    name: str
+    features: dict[str, bool] = Field(default_factory=dict)

sdk/models/chunks.py

@@ -0,0 +1,20 @@
+"""Pydantic models for chunk types."""
+
+from __future__ import annotations
+
+from sdk.models._base import K2BaseModel
+
+
+class ChunkListItemModel(K2BaseModel):
+    id: str | None = None
+    text: str | None = None
+    custom_metadata: dict | None = None
+    system_metadata: dict | None = None
+    offset_start: int | None = None
+    offset_end: int | None = None
+    page_start: int | None = None
+    page_end: int | None = None
+
+
+class ChunkListResponseModel(K2BaseModel):
+    chunks: list[ChunkListItemModel]

sdk/models/common.py

@@ -0,0 +1,14 @@
+"""Pydantic models for common types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sdk.models._base import K2BaseModel
+
+
+class ApiErrorDetailModel(K2BaseModel):
+    code: str | None = None
+    message: str | None = None
+    details: Any | None = None
+    request_id: str | None = None

sdk/models/console.py

@@ -0,0 +1,103 @@
+"""Pydantic models for console types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sdk.models._base import K2BaseModel
+from sdk.models.jobs import JobListItemModel
+
+
+class ConsoleMeResponseModel(K2BaseModel):
+    provisioned: bool | None = None
+    org_id: str | None = None
+    org_name: str | None = None
+    project_id: str | None = None
+    project_name: str | None = None
+    role: str | None = None
+    is_org_admin: bool | None = None
+    auth_subject: str | None = None
+    user_id: str | None = None
+    email: str | None = None
+    name: str | None = None
+
+
+class ConsoleBootstrapResponseModel(ConsoleMeResponseModel):
+    created: bool | None = None
+
+
+class ConsoleSummaryResponseModel(K2BaseModel):
+    corpora_total: int
+    documents_total: int
+    documents_failed: int
+    recent_jobs: list[JobListItemModel]
+
+
+class ConsoleProjectItemModel(K2BaseModel):
+    id: str | None = None
+    name: str | None = None
+    org_id: str | None = None
+    role: str | None = None
+    graph_rag_policy: dict[str, Any] | None = None
+
+
+class ConsoleProjectListResponseModel(K2BaseModel):
+    projects: list[ConsoleProjectItemModel]
+
+
+class ConsoleOrgResponseModel(K2BaseModel):
+    id: str | None = None
+    name: str | None = None
+    contact_email: str | None = None
+
+
+class TeamMemberModel(K2BaseModel):
+    membership_id: str | None = None
+    user_id: str | None = None
+    email: str | None = None
+    name: str | None = None
+    role: str | None = None
+    created_at: str | None = None
+    is_current_user: bool | None = None
+
+
+class TeamListResponseModel(K2BaseModel):
+    members: list[TeamMemberModel]
+
+
+class InviteListItemModel(K2BaseModel):
+    id: str | None = None
+    email: str | None = None
+    role: str | None = None
+    created_at: str | None = None
+    expires_at: str | None = None
+    accepted_at: str | None = None
+
+
+class InviteListResponseModel(K2BaseModel):
+    invites: list[InviteListItemModel]
+
+
+class InviteCreateResponseModel(K2BaseModel):
+    id: str | None = None
+    email: str | None = None
+    role: str | None = None
+    token: str | None = None
+    expires_at: str | None = None
+
+
+class InviteAcceptResponseModel(K2BaseModel):
+    org_id: str | None = None
+    org_name: str | None = None
+    project_id: str | None = None
+    project_name: str | None = None
+    role: str | None = None
+
+
+class MemberUpdateResponseModel(K2BaseModel):
+    updated: bool
+    role: str
+
+
+class MemberRemoveResponseModel(K2BaseModel):
+    removed: bool

sdk/models/corpora.py

@@ -0,0 +1,48 @@
+"""Pydantic models for corpora types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sdk.models._base import K2BaseModel
+
+
+class CorpusResponseModel(K2BaseModel):
+    id: str | None = None
+    project_id: str | None = None
+    name: str | None = None
+    description: str | None = None
+    is_tutorial: bool | None = None
+    is_demo: bool | None = None
+    current_model_id: str | None = None
+    created_at: str | None = None
+    org_name: str | None = None
+    project_name: str | None = None
+    chunking_config: dict[str, Any] | None = None
+    graph_rag_policy: dict[str, Any] | None = None
+
+
+class CorpusListResponseModel(K2BaseModel):
+    corpora: list[CorpusResponseModel]
+    total: int
+
+
+class CorpusDeleteResponseModel(K2BaseModel):
+    message: str | None = None
+    counts: dict[str, int] | None = None
+
+
+class CorpusStatusResponseModel(K2BaseModel):
+    status: str | None = None
+    search_status: str | None = None
+    retrieval_ready: bool | None = None
+    retrieval_status: str | None = None
+    ingesting: bool | None = None
+    indexing: bool | None = None
+    document_count: int | None = None
+    documents_processing: int | None = None
+    documents_failed: int | None = None
+    documents_failed_ratio: float | None = None
+    dense_status: str | None = None
+    sparse_status: str | None = None
+    graph_status: str | None = None

sdk/models/deployments.py

@@ -0,0 +1,13 @@
+"""Pydantic models for deployment types."""
+
+from __future__ import annotations
+
+from sdk.models._base import K2BaseModel
+
+
+class DeploymentResponseModel(K2BaseModel):
+    id: str | None = None
+    corpus_id: str | None = None
+    model_id: str | None = None
+    traffic_pct: int | None = None
+    reindex_job_id: str | None = None

sdk/models/documents.py

@@ -0,0 +1,126 @@
+"""Pydantic models for document types."""
+
+from __future__ import annotations
+
+import logging
+from typing import Literal
+
+from pydantic import model_validator
+
+from sdk.models._base import K2BaseModel
+
+logger = logging.getLogger(__name__)
+
+
+class ChunkingConfigModel(K2BaseModel):
+    strategy: (
+        Literal["fixed", "paragraph", "semantic", "semchunk", "unstructured", "docling"] | None
+    ) = None
+    chunking_strategy: Literal["basic", "by_title", "by_page", "by_similarity"] | None = None
+    chunk_size: int | None = None
+    overlap: int | None = None
+    combine_text_under_n_chars: int | None = None
+    multipage_sections: bool | None = None
+    new_after_n_chars: int | None = None
+    max_concurrent_requests: int | None = None
+    timeout: int | None = None
+    dedup_mode: Literal["off", "minhash"] | None = None
+    dedup_partition_keys: list[str] | None = None
+    docling_chunker_type: Literal["hybrid", "hierarchical"] | None = None
+    docling_tokenizer_model: str | None = None
+    docling_max_tokens: int | None = None
+    docling_merge_peers: bool | None = None
+    docling_merge_list_items: bool | None = None
+    docling_processing_mode: Literal["auto", "sequential", "batch"] | None = None
+    docling_accelerator: Literal["auto", "cuda", "cpu"] | None = None
+
+    @model_validator(mode="before")
+    @classmethod
+    def _normalize_legacy_docling_ray_config(cls, value):
+        if not isinstance(value, dict):
+            return value
+
+        normalized = dict(value)
+        removed_fields = (
+            "docling_ray_num_workers",
+            "docling_ray_docs_per_batch",
+            "docling_min_batch_size",
+            "docling_min_ray_threshold_multiplier",
+        )
+        ignored = [field for field in removed_fields if field in normalized]
+        if ignored:
+            logger.warning(
+                "Ignoring removed Docling Ray chunking fields in SDK model: %s",
+                ", ".join(sorted(ignored)),
+            )
+            for field_name in ignored:
+                normalized.pop(field_name, None)
+
+        processing_mode = normalized.get("docling_processing_mode")
+        if isinstance(processing_mode, str) and processing_mode.strip().lower() == "ray":
+            logger.warning(
+                "Docling processing mode 'ray' is no longer supported; using 'batch' instead"
+            )
+            normalized["docling_processing_mode"] = "batch"
+
+        return normalized
+
+
+class DocumentCreateResponseModel(K2BaseModel):
+    id: str
+    job_id: str
+
+
+class DocumentBatchItemModel(K2BaseModel):
+    source_uri: str | None = None
+    raw_text: str | None = None
+    metadata: dict | None = None
+
+
+class DocumentUrlItemModel(K2BaseModel):
+    url: str | None = None
+    title: str | None = None
+    tags: list[str] | None = None
+    metadata: dict | None = None
+
+
+class DocumentUrlIngestResponseModel(K2BaseModel):
+    job_id: str
+    submitted: int
+
+
+class DocumentManifestIngestResponseModel(K2BaseModel):
+    job_id: str
+
+
+class DocumentListItemModel(K2BaseModel):
+    id: str | None = None
+    corpus_id: str | None = None
+    source_uri: str | None = None
+    custom_metadata: dict | None = None
+    system_metadata: dict | None = None
+    created_at: str | None = None
+    status: str | None = None
+    size_bytes: int | None = None
+    content_type: str | None = None
+    preview: str | None = None
+
+
+class DocumentListResponseModel(K2BaseModel):
+    documents: list[DocumentListItemModel]
+    total: int
+
+
+class DocumentDetailResponseModel(DocumentListItemModel):
+    pass
+
+
+class DocumentDeleteResponseModel(K2BaseModel):
+    message: str | None = None
+    reindex_job_id: str | None = None
+
+
+class DocumentBatchUploadResponseModel(K2BaseModel):
+    job_id: str
+    doc_ids: list[str]
+    count: int

sdk/models/embeddings.py

@@ -0,0 +1,24 @@
+"""Pydantic models for embedding types."""
+
+from __future__ import annotations
+
+from sdk.models._base import K2BaseModel
+
+
+class EmbeddingItemModel(K2BaseModel):
+    embedding: list[float]
+    index: int
+
+
+class EmbeddingsResponseModel(K2BaseModel):
+    data: list[EmbeddingItemModel]
+    model: str
+
+
+class EmbeddingModelInfoModel(K2BaseModel):
+    model_name: str
+    is_default: bool
+
+
+class EmbeddingModelListResponseModel(K2BaseModel):
+    models: list[EmbeddingModelInfoModel]

sdk/models/evaluation.py

@@ -0,0 +1,17 @@
+"""Pydantic models for evaluation types."""
+
+from __future__ import annotations
+
+from sdk.models._base import K2BaseModel
+
+
+class EvalRunResponseModel(K2BaseModel):
+    eval_id: str
+    status: str
+    job_id: str
+
+
+class EvalRunDetailResponseModel(K2BaseModel):
+    eval_id: str | None = None
+    status: str | None = None
+    metrics: dict | None = None

sdk/models/feedback.py

@@ -0,0 +1,9 @@
+"""Pydantic models for feedback types."""
+
+from __future__ import annotations
+
+from sdk.models._base import K2BaseModel
+
+
+class FeedbackResponseModel(K2BaseModel):
+    message: str

sdk/models/feeds.py

@@ -0,0 +1,57 @@
+"""Pydantic models for feed types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sdk.models._base import K2BaseModel
+
+
+class FeedSubscriptionResponseModel(K2BaseModel):
+    id: str | None = None
+    agent_id: str | None = None
+    agent_name: str | None = None
+    role: str | None = None
+
+
+class FeedResponseModel(K2BaseModel):
+    id: str | None = None
+    project_id: str | None = None
+    agent_id: str | None = None
+    name: str | None = None
+    query: str | None = None
+    persistent: bool | None = None
+    reactive: bool | None = None
+    target_corpus_id: str | None = None
+    schedule_interval: str | None = None
+    schedule_hour: int | None = None
+    start_from: str | None = None
+    top_k: int | None = None
+    metadata_filters: dict[str, Any] | None = None
+    activation_status: str | None = None
+    last_checked_seq: int | None = None
+    last_run_at: str | None = None
+    last_run_result_count: int | None = None
+    subscriptions: list[FeedSubscriptionResponseModel] | None = None
+    parent_feed_id: str | None = None
+    has_draft: bool | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+
+
+class FeedListResponseModel(K2BaseModel):
+    feeds: list[FeedResponseModel]
+    total: int
+    limit: int
+    offset: int
+
+
+class FeedRunResponseModel(K2BaseModel):
+    new_content: bool | None = None
+    results: list[dict[str, Any]] | None = None
+    result_count: int | None = None
+    truncated: bool | None = None
+    ingestion_job_id: str | None = None
+    dry_run: bool | None = None
+    would_ingest_count: int | None = None
+    feed_run_id: str | None = None

sdk/models/indexes.py

@@ -0,0 +1,36 @@
+"""Pydantic models for index types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sdk.models._base import K2BaseModel
+
+
+class IndexBuildResponseModel(K2BaseModel):
+    job_id: str
+    index_ids: list[str]
+
+
+class IndexStatusResponseModel(K2BaseModel):
+    build_set_id: str | None = None
+    requested_mode: str | None = None
+    effective_mode: str | None = None
+    start_change_seq_exclusive: int | None = None
+    end_change_seq_inclusive: int | None = None
+    retrieval_status: str | None = None
+    retrieval_reason: str | None = None
+    document_count: int | None = None
+    dense_status: str | None = None
+    sparse_status: str | None = None
+    sparse_metadata_status: str | None = None
+    graph_status: str | None = None
+    dense_reason: str | None = None
+    sparse_reason: str | None = None
+    sparse_metadata_reason: str | None = None
+    graph_reason: str | None = None
+
+
+class IndexCompactResponseModel(K2BaseModel):
+    archived: Any | None = None
+    keep: int | None = None

sdk/models/jobs.py

@@ -0,0 +1,52 @@
+"""Pydantic models for job types."""
+
+from __future__ import annotations
+
+from sdk.models._base import K2BaseModel
+
+
+class JobActionsModel(K2BaseModel):
+    can_cancel: bool | None = None
+    can_retry: bool | None = None
+
+
+class JobResponseModel(K2BaseModel):
+    id: str | None = None
+    job_type: str | None = None
+    status: str | None = None
+    actions: JobActionsModel | None = None
+    payload: dict | None = None
+    result: dict | None = None
+    error_message: str | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+    heartbeat_at: str | None = None
+    requeue_count: int | None = None
+    run_after: str | None = None
+
+
+class JobListItemModel(K2BaseModel):
+    id: str | None = None
+    job_type: str | None = None
+    status: str | None = None
+    actions: JobActionsModel | None = None
+    payload: dict | None = None
+    result: dict | None = None
+    error_message: str | None = None
+    created_at: str | None = None
+    updated_at: str | None = None
+    heartbeat_at: str | None = None
+    requeue_count: int | None = None
+    run_after: str | None = None
+
+
+class JobListResponseModel(K2BaseModel):
+    jobs: list[JobListItemModel]
+
+
+class JobStatusResponseModel(K2BaseModel):
+    status: str
+
+
+class ReconcileJobsResponseModel(K2BaseModel):
+    reconciled: int

sdk/models/models.py

@@ -0,0 +1,26 @@
+"""Pydantic models for model types."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sdk.models._base import K2BaseModel
+
+
+class ModelResponseModel(K2BaseModel):
+    id: str | None = None
+    corpus_id: str | None = None
+    base_model: str | None = None
+    embedding_dim: int | None = None
+    max_seq_length: int | None = None
+    version: int | None = None
+    created_at: str | None = None
+
+
+class ModelListResponseModel(K2BaseModel):
+    models: list[ModelResponseModel]
+
+
+class ModelDeleteResponseModel(K2BaseModel):
+    message: str | None = None
+    counts: dict[str, Any] | None = None