arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/multimodal_embedding/embedding_usage.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 arkruntime._models import BaseModel
+
+from .prompt_tokens_details import PromptTokensDetails
+
+
+class EmbeddingUsage(BaseModel):
+    prompt_tokens: int
+    """
+    The number of prompt tokens used.
+    """
+    total_tokens: int
+    """
+    The total number of tokens used.
+    """
+    prompt_tokens_details: PromptTokensDetails
+    """
+    A detailed breakdown of the prompt tokens.
+    """

arkruntime/types/multimodal_embedding/encoding_format.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 EncodingFormat(str, Enum):
+    base64 = "base64"
+    float = "float"

arkruntime/types/multimodal_embedding/image_url.py

@@ -0,0 +1,16 @@
+# 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 ImageURL(BaseModel):
+    url: str
+    """
+    The URL of the image to embed.
+    """

arkruntime/types/multimodal_embedding/image_url_param.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 typing_extensions import Required, TypedDict
+
+
+class ImageURLParam(TypedDict, total=False):
+    url: Required[str]
+    """The URL of the image to embed."""

arkruntime/types/multimodal_embedding/multi_embedding_config.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 arkruntime._models import BaseModel
+
+from .multi_embedding_mode import MultiEmbeddingMode
+
+
+class MultiEmbeddingConfig(BaseModel):
+    type: MultiEmbeddingMode
+    """
+    Whether per-modality embeddings should be returned in addition to the joint embedding.
+    """

arkruntime/types/multimodal_embedding/multi_embedding_config_param.py

@@ -0,0 +1,17 @@
+# 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_extensions import Required, TypedDict
+
+
+from .multi_embedding_mode import MultiEmbeddingMode
+
+
+class MultiEmbeddingConfigParam(TypedDict, total=False):
+    type: Required[MultiEmbeddingMode]
+    """Whether per-modality embeddings should be returned in addition to the joint embedding."""

arkruntime/types/multimodal_embedding/multi_embedding_mode.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 MultiEmbeddingMode(str, Enum):
+    enabled = "enabled"
+    disabled = "disabled"

arkruntime/types/multimodal_embedding/multi_modal_embedding_request.py

@@ -0,0 +1,47 @@
+# 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 .embedding_input import EmbeddingInput
+from .encoding_format import EncodingFormat
+from .multi_embedding_config import MultiEmbeddingConfig
+from .sparse_embedding_config import SparseEmbeddingConfig
+
+
+class MultiModalEmbeddingRequest(BaseModel):
+    model: str
+    """
+    The model identifier to use.
+    """
+    input: List[EmbeddingInput]
+    """
+    The list of multimodal inputs to embed.
+    """
+    encoding_format: Optional[EncodingFormat] = None
+    """
+    The format embeddings are returned in. Defaults to `float`.
+    """
+    dimensions: Optional[int] = None
+    """
+    Override the embedding dimensionality.
+    """
+    sparse_embedding: Optional[SparseEmbeddingConfig] = None
+    """
+    Sparse embedding configuration.
+    """
+    multi_embedding: Optional[MultiEmbeddingConfig] = None
+    """
+    Multi-embedding configuration (per-modality vectors).
+    """
+    instructions: Optional[str] = None
+    """
+    Optional natural-language instructions to steer the embedding.
+    """

arkruntime/types/multimodal_embedding/multi_modal_embedding_request_param.py

@@ -0,0 +1,39 @@
+# 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 typing_extensions import Required, TypedDict
+
+from .embedding_input_param import EmbeddingInputParam
+from .encoding_format import EncodingFormat
+from .multi_embedding_config_param import MultiEmbeddingConfigParam
+from .sparse_embedding_config_param import SparseEmbeddingConfigParam
+
+
+class MultiModalEmbeddingRequestParam(TypedDict, total=False):
+    model: Required[str]
+    """The model identifier to use."""
+
+    input: Required[List[EmbeddingInputParam]]
+    """The list of multimodal inputs to embed."""
+
+    encoding_format: Optional[EncodingFormat]
+    """The format embeddings are returned in. Defaults to `float`."""
+
+    dimensions: Optional[int]
+    """Override the embedding dimensionality."""
+
+    sparse_embedding: Optional[SparseEmbeddingConfigParam]
+    """Sparse embedding configuration."""
+
+    multi_embedding: Optional[MultiEmbeddingConfigParam]
+    """Multi-embedding configuration (per-modality vectors)."""
+
+    instructions: Optional[str]
+    """Optional natural-language instructions to steer the embedding."""

arkruntime/types/multimodal_embedding/multi_modal_embedding_response.py

@@ -0,0 +1,41 @@
+# 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
+
+from .embedding_data_item import EmbeddingDataItem
+from .embedding_usage import EmbeddingUsage
+
+
+class MultiModalEmbeddingResponse(BaseModel):
+    id: str
+    """
+    The unique identifier for the embedding response.
+    """
+    model: str
+    """
+    The model that produced the embeddings.
+    """
+    created: int
+    """
+    Unix timestamp (in seconds) of when the response was created.
+    """
+    object: Literal["list"]
+    """
+    The object type. Always `list`.
+    """
+    data: EmbeddingDataItem
+    """
+    The embedding result.
+    """
+    usage: EmbeddingUsage
+    """
+    Token usage information.
+    """

arkruntime/types/multimodal_embedding/prompt_tokens_details.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 arkruntime._models import BaseModel
+
+
+class PromptTokensDetails(BaseModel):
+    text_tokens: int
+    """
+    The number of prompt tokens consumed by text inputs.
+    """
+    image_tokens: int
+    """
+    The number of prompt tokens consumed by image inputs.
+    """

arkruntime/types/multimodal_embedding/sparse_embedding_config.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 typing import Optional
+
+from arkruntime._models import BaseModel
+
+from .sparse_embedding_mode import SparseEmbeddingMode
+
+
+class SparseEmbeddingConfig(BaseModel):
+    type: Optional[SparseEmbeddingMode] = None
+    """
+    Whether sparse embeddings should be returned.
+    """

arkruntime/types/multimodal_embedding/sparse_embedding_config_param.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 typing import Optional
+
+from typing_extensions import TypedDict
+
+from .sparse_embedding_mode import SparseEmbeddingMode
+
+
+class SparseEmbeddingConfigParam(TypedDict, total=False):
+    type: Optional[SparseEmbeddingMode]
+    """Whether sparse embeddings should be returned."""

arkruntime/types/multimodal_embedding/sparse_embedding_mode.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 SparseEmbeddingMode(str, Enum):
+    enabled = "enabled"
+    disabled = "disabled"

arkruntime/types/multimodal_embedding/sparse_embedding_value.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 arkruntime._models import BaseModel
+
+
+class SparseEmbeddingValue(BaseModel):
+    index: int
+    """
+    Index of the non-zero dimension.
+    """
+    value: float
+    """
+    Value at that dimension.
+    """

arkruntime/types/multimodal_embedding/video_url.py

@@ -0,0 +1,22 @@
+# 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 VideoURL(BaseModel):
+    url: str
+    """
+    The URL of the video to embed.
+    """
+    fps: Optional[float] = None
+    """
+    Frames-per-second sampling rate for the video.
+    """

arkruntime/types/multimodal_embedding/video_url_param.py

@@ -0,0 +1,19 @@
+# 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
+
+
+class VideoURLParam(TypedDict, total=False):
+    url: Required[str]
+    """The URL of the video to embed."""
+
+    fps: Optional[float]
+    """Frames-per-second sampling rate for the video."""