arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/memory/create_memory_request.py

@@ -0,0 +1,24 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from arkruntime._models import BaseModel
+
+
+class CreateMemoryRequest(BaseModel):
+    """
+    创建 Memory 的请求体。`path` 在同一 store 内唯一。
+    """
+
+    path: str
+    """
+    文件路径。
+    """
+    content: str
+    """
+    文件内容。
+    """

arkruntime/types/memory/create_memory_store_request.py

@@ -0,0 +1,30 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+
+from arkruntime._models import BaseModel
+
+
+class CreateMemoryStoreRequest(BaseModel):
+    """
+    创建 MemoryStore 的请求体。
+    """
+
+    name: str
+    """
+    人类可读名称。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据。
+    """

arkruntime/types/memory/delete_memory_response.py

@@ -0,0 +1,26 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal
+
+from arkruntime._models import BaseModel
+
+
+class DeleteMemoryResponse(BaseModel):
+    """
+    Delete Memory 响应体。
+    """
+
+    id: str
+    """
+    被删除的 Memory ID。
+    """
+    type: Literal["memory_deleted"]
+    """
+    固定 `"memory_deleted"`。
+    """

arkruntime/types/memory/delete_memory_store_response.py

@@ -0,0 +1,26 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal
+
+from arkruntime._models import BaseModel
+
+
+class DeleteMemoryStoreResponse(BaseModel):
+    """
+    Delete MemoryStore 响应体。
+    """
+
+    id: str
+    """
+    被删除的 MemoryStore ID。
+    """
+    type: Literal["memory_store_deleted"]
+    """
+    固定 `"memory_store_deleted"`。
+    """

arkruntime/types/memory/list_memories_order_by.py

@@ -0,0 +1,18 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class ListMemoriesOrderBy(str, Enum):
+    """
+    List Memories 排序字段。
+    """
+
+    path = "path"
+    updated_at = "updated_at"

arkruntime/types/memory/list_memories_response.py

@@ -0,0 +1,32 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from arkruntime._models import BaseModel
+
+from .memory_list_item import MemoryListItem
+
+
+class ListMemoriesResponse(BaseModel):
+    """
+    List Memories 响应体。
+    """
+
+    data: List[MemoryListItem]
+    """
+    本页元素列表（memory 与 memory_prefix 混排）。
+    """
+    next_page: Optional[str] = None
+    """
+    下一页 cursor；已列尽时为空或缺省。
+    """
+    prefixes: List[str]
+    """
+    命中的所有折叠前缀。
+    """

arkruntime/types/memory/list_memory_stores_response.py

@@ -0,0 +1,28 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Optional
+
+from arkruntime._models import BaseModel
+
+from .memory_store import MemoryStore
+
+
+class ListMemoryStoresResponse(BaseModel):
+    """
+    List MemoryStores 响应体。
+    """
+
+    data: List[MemoryStore]
+    """
+    本页 MemoryStore 列表。
+    """
+    next_page: Optional[str] = None
+    """
+    下一页 cursor；已列尽时为空或缺省。
+    """

arkruntime/types/memory/memory.py

@@ -0,0 +1,64 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .actor import Actor
+
+
+class Memory(BaseModel):
+    """
+    一条记忆（store 内一个文件）。`content` 仅 Get 单条时返回。
+    """
+
+    id: str
+    """
+    Memory ID。
+    """
+    type: Literal["memory"]
+    """
+    固定 `"memory"`。
+    """
+    memory_store_id: str
+    """
+    归属的 MemoryStore ID。
+    """
+    path: str
+    """
+    store 内唯一的文件路径。
+    """
+    content: Optional[str] = None
+    """
+    文件内容，仅 GetMemory 单条时返回；List/Create/Update 响应中不携带。
+    """
+    content_sha256: str
+    """
+    内容 SHA256（十六进制）。
+    """
+    content_size_bytes: int
+    """
+    内容字节数。
+    """
+    memory_version_id: str
+    """
+    内容版本 ID。
+    """
+    created_by: Actor
+    """
+    创建人。
+    """
+    created_at: str
+    """
+    RFC 3339 时间。
+    """
+    updated_at: str
+    """
+    RFC 3339 时间。
+    """

arkruntime/types/memory/memory_list_item.py

@@ -0,0 +1,58 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .memory_list_item_type import MemoryListItemType
+
+
+class MemoryListItem(BaseModel):
+    """
+    List 响应 `data` 的元素：
+    - `type = memory` 时为文件项，填精简元信息（不含 `content`）
+    - `type = memory_prefix` 时为折叠目录项，仅 `type` + `path`（`/` 结尾）
+    """
+
+    type: MemoryListItemType
+    """
+    元素类型。
+    """
+    path: str
+    """
+    文件路径或折叠目录路径。
+    """
+    id: Optional[str] = None
+    """
+    Memory ID；仅 `type=memory` 时返回。
+    """
+    memory_store_id: Optional[str] = None
+    """
+    归属的 MemoryStore ID；仅 `type=memory` 时返回。
+    """
+    content_sha256: Optional[str] = None
+    """
+    内容 SHA256；仅 `type=memory` 时返回。
+    """
+    content_size_bytes: Optional[int] = None
+    """
+    内容字节数；仅 `type=memory` 时返回。
+    """
+    memory_version_id: Optional[str] = None
+    """
+    内容版本 ID；仅 `type=memory` 时返回。
+    """
+    created_at: Optional[str] = None
+    """
+    RFC 3339 时间；仅 `type=memory` 时返回。
+    """
+    updated_at: Optional[str] = None
+    """
+    RFC 3339 时间；仅 `type=memory` 时返回。
+    """

arkruntime/types/memory/memory_list_item_type.py

@@ -0,0 +1,20 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class MemoryListItemType(str, Enum):
+    """
+    List Memories 响应中的元素类型。
+    - `memory`：单条文件项，携带元信息
+    - `memory_prefix`：折叠目录项，仅 `type` + `path`（以 `/` 结尾）
+    """
+
+    memory = "memory"
+    memory_prefix = "memory_prefix"

arkruntime/types/memory/memory_store.py

@@ -0,0 +1,64 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Dict, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .actor import Actor
+
+
+class MemoryStore(BaseModel):
+    """
+    一个记忆库。
+    """
+
+    id: str
+    """
+    MemoryStore ID。
+    """
+    type: Literal["memory_store"]
+    """
+    固定 `"memory_store"`。
+    """
+    name: str
+    """
+    人类可读名称。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    memory_count: int
+    """
+    库内 memory 条数。
+    """
+    storage_bytes: int
+    """
+    库内 memory 内容占用字节数。
+    """
+    session_count: int
+    """
+    引用了本库的 session 数。
+    """
+    created_by: Actor
+    """
+    创建人。
+    """
+    created_at: str
+    """
+    RFC 3339 时间。
+    """
+    updated_at: str
+    """
+    RFC 3339 时间。
+    """
+    metadata: Dict[str, str]
+    """
+    用户自定义键值对元数据。
+    """

arkruntime/types/memory/update_memory_request.py

@@ -0,0 +1,27 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+
+class UpdateMemoryRequest(BaseModel):
+    """
+    更新 Memory 的请求体；
+    `content` 与 `path` 至少给一个（重命名或改内容）。
+    """
+
+    content: Optional[str] = None
+    """
+    更新后的文件内容。
+    """
+    path: Optional[str] = None
+    """
+    更新后的文件路径（重命名）。
+    """

arkruntime/types/memory/update_memory_store_request.py

@@ -0,0 +1,31 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Dict, Optional
+
+from arkruntime._models import BaseModel
+
+
+class UpdateMemoryStoreRequest(BaseModel):
+    """
+    更新 MemoryStore 的请求体；
+    `name` / `description` / `metadata` 至少给一个。
+    """
+
+    name: Optional[str] = None
+    """
+    人类可读名称。
+    """
+    description: Optional[str] = None
+    """
+    描述信息。
+    """
+    metadata: Optional[Dict[str, str]] = None
+    """
+    用户自定义键值对元数据（patch）。
+    """

arkruntime/types/multimodal_embedding/__init__.py

@@ -0,0 +1,54 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from .embedding import Embedding
+from .embedding_data_item import EmbeddingDataItem
+from .embedding_input import EmbeddingInput
+from .embedding_input_type import EmbeddingInputType
+from .embedding_object import EmbeddingObject
+from .embedding_usage import EmbeddingUsage
+from .encoding_format import EncodingFormat
+from .image_url import ImageURL
+from .multi_embedding_config import MultiEmbeddingConfig
+from .multi_embedding_mode import MultiEmbeddingMode
+from .multi_modal_embedding_request import MultiModalEmbeddingRequest
+from .multi_modal_embedding_response import MultiModalEmbeddingResponse
+from .prompt_tokens_details import PromptTokensDetails
+from .sparse_embedding_config import SparseEmbeddingConfig
+from .sparse_embedding_mode import SparseEmbeddingMode
+from .sparse_embedding_value import SparseEmbeddingValue
+from .video_url import VideoURL
+
+__all__ = [
+    "Embedding",
+    "EmbeddingDataItem",
+    "EmbeddingInput",
+    "EmbeddingInputType",
+    "EmbeddingObject",
+    "EmbeddingUsage",
+    "EncodingFormat",
+    "ImageURL",
+    "MultiEmbeddingConfig",
+    "MultiEmbeddingMode",
+    "MultiModalEmbeddingRequest",
+    "MultiModalEmbeddingResponse",
+    "PromptTokensDetails",
+    "SparseEmbeddingConfig",
+    "SparseEmbeddingMode",
+    "SparseEmbeddingValue",
+    "VideoURL",
+]
+from .embedding_input_param import EmbeddingInputParam
+from .image_url_param import ImageURLParam
+from .multi_embedding_config_param import MultiEmbeddingConfigParam
+from .multi_modal_embedding_request_param import MultiModalEmbeddingRequestParam
+from .sparse_embedding_config_param import SparseEmbeddingConfigParam
+from .video_url_param import VideoURLParam
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime/types/multimodal_embedding/_init_extras_shim.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+"""Hand-written extras shim for the multimodal_embedding API (empty stub).
+
+Preserved across regen via the Makefile rsync --exclude=*_shim.py rule.
+Add re-exports here as needed.
+"""
+
+from __future__ import annotations
+
+__all__: list[str] = []

arkruntime/types/multimodal_embedding/embedding.py

@@ -0,0 +1,13 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Union
+
+from typing_extensions import TypeAliasType
+
+Embedding = TypeAliasType("Embedding", Union[List[float], str])

arkruntime/types/multimodal_embedding/embedding_data_item.py

@@ -0,0 +1,33 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .embedding import Embedding
+from .sparse_embedding_value import SparseEmbeddingValue
+
+
+class EmbeddingDataItem(BaseModel):
+    embedding: Embedding
+    """
+    The (dense) embedding vector.
+    """
+    sparse_embedding: Optional[List[SparseEmbeddingValue]] = None
+    """
+    Sparse embedding entries when sparse embeddings were requested.
+    """
+    object: Literal["embedding"]
+    """
+    The object type. Always `embedding`.
+    """
+    multi_embedding: Optional[List[Embedding]] = None
+    """
+    Per-modality embeddings when `multi_embedding` was requested.
+    """

arkruntime/types/multimodal_embedding/embedding_input.py

@@ -0,0 +1,34 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .embedding_input_type import EmbeddingInputType
+from .image_url import ImageURL
+from .video_url import VideoURL
+
+
+class EmbeddingInput(BaseModel):
+    type: EmbeddingInputType
+    """
+    Discriminator for which content field is set.
+    """
+    text: Optional[str] = None
+    """
+    Text content. Required when `type` is `text`.
+    """
+    image_url: Optional[ImageURL] = None
+    """
+    Image content. Required when `type` is `image_url`.
+    """
+    video_url: Optional[VideoURL] = None
+    """
+    Video content. Required when `type` is `video_url`.
+    """

arkruntime/types/multimodal_embedding/embedding_input_param.py

@@ -0,0 +1,29 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from typing_extensions import Required, TypedDict
+
+from .embedding_input_type import EmbeddingInputType
+from .image_url_param import ImageURLParam
+from .video_url_param import VideoURLParam
+
+
+class EmbeddingInputParam(TypedDict, total=False):
+    type: Required[EmbeddingInputType]
+    """Discriminator for which content field is set."""
+
+    text: Optional[str]
+    """Text content. Required when `type` is `text`."""
+
+    image_url: Optional[ImageURLParam]
+    """Image content. Required when `type` is `image_url`."""
+
+    video_url: Optional[VideoURLParam]
+    """Video content. Required when `type` is `video_url`."""

arkruntime/types/multimodal_embedding/embedding_input_type.py

@@ -0,0 +1,15 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class EmbeddingInputType(str, Enum):
+    text = "text"
+    image_url = "image_url"
+    video_url = "video_url"

arkruntime/types/multimodal_embedding/embedding_object.py

@@ -0,0 +1,14 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from enum import Enum
+
+
+class EmbeddingObject(str, Enum):
+    embedding = "embedding"
+    list = "list"