arkruntime 0.2.0__tar.gz → 0.3.0__tar.gz

{arkruntime-0.2.0 → arkruntime-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: arkruntime
-Version: 0.2.0
+Version: 0.3.0
 Summary: Ark runtime SDK for Python
 Author: Volcengine
 License: Apache-2.0

{arkruntime-0.2.0 → arkruntime-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "arkruntime"
-version = "0.2.0"
+version = "0.3.0"
 description = "Ark runtime SDK for Python"
 readme = "README.md"
 requires-python = ">=3.8"

arkruntime-0.3.0/src/arkruntime/types/messages/__init__.py

@@ -0,0 +1,206 @@
+# 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 .content import Content
+from .content_block_start import ContentBlockStart
+from .content_block_start_content_block import ContentBlockStartContentBlock
+from .count_tokens_response import CountTokensResponse
+from .error import Error
+from .messages_content_part import MessagesContentPart
+from .messages_content_part_document import MessagesContentPartDocument
+from .messages_content_part_document_source import MessagesContentPartDocumentSource
+from .messages_content_part_image import MessagesContentPartImage
+from .messages_content_part_image_source import MessagesContentPartImageSource
+from .messages_content_part_server_tool_use import MessagesContentPartServerToolUse
+from .messages_content_part_text import MessagesContentPartText
+from .messages_content_part_thinking import MessagesContentPartThinking
+from .messages_content_part_tool_reference import MessagesContentPartToolReference
+from .messages_content_part_tool_result import MessagesContentPartToolResult
+from .messages_content_part_tool_use import MessagesContentPartToolUse
+from .messages_content_part_web_search_tool_result import (
+    MessagesContentPartWebSearchToolResult,
+)
+from .messages_context_management import MessagesContextManagement
+from .messages_context_management_clear_thinking import (
+    MessagesContextManagementClearThinking,
+)
+from .messages_context_management_clear_tool_uses import (
+    MessagesContextManagementClearToolUses,
+)
+from .messages_context_management_clear_tool_uses_trigger import (
+    MessagesContextManagementClearToolUsesTrigger,
+)
+from .messages_context_management_edit import MessagesContextManagementEdit
+from .messages_context_management_keep import MessagesContextManagementKeep
+from .messages_context_management_keep_all import MessagesContextManagementKeepAll
+from .messages_context_management_keep_thinking_turns import (
+    MessagesContextManagementKeepThinkingTurns,
+)
+from .messages_context_management_keep_tool_uses import (
+    MessagesContextManagementKeepToolUses,
+)
+from .messages_document_source_type import MessagesDocumentSourceType
+from .messages_error_response import MessagesErrorResponse
+from .messages_image_source_type import MessagesImageSourceType
+from .messages_iteration_usage import MessagesIterationUsage
+from .messages_message_content import MessagesMessageContent
+from .messages_metadata import MessagesMetadata
+from .messages_output_config import MessagesOutputConfig
+from .messages_output_format import MessagesOutputFormat
+from .messages_output_format_type import MessagesOutputFormatType
+from .messages_request import MessagesRequest
+from .messages_request_message import MessagesRequestMessage
+from .messages_request_service_tier import MessagesRequestServiceTier
+from .messages_response import MessagesResponse
+from .messages_response_content_block import MessagesResponseContentBlock
+from .messages_response_content_block_delta import MessagesResponseContentBlockDelta
+from .messages_response_content_block_delta_signature import (
+    MessagesResponseContentBlockDeltaSignature,
+)
+from .messages_response_content_block_delta_text import (
+    MessagesResponseContentBlockDeltaText,
+)
+from .messages_response_content_block_delta_thinking import (
+    MessagesResponseContentBlockDeltaThinking,
+)
+from .messages_response_content_block_delta_tool_use import (
+    MessagesResponseContentBlockDeltaToolUse,
+)
+from .messages_response_content_block_stop import MessagesResponseContentBlockStop
+from .messages_response_content_part import MessagesResponseContentPart
+from .messages_response_content_part_server_tool_use import (
+    MessagesResponseContentPartServerToolUse,
+)
+from .messages_response_content_part_text import MessagesResponseContentPartText
+from .messages_response_content_part_thinking import MessagesResponseContentPartThinking
+from .messages_response_content_part_tool_use import MessagesResponseContentPartToolUse
+from .messages_response_content_part_web_search_tool_result import (
+    MessagesResponseContentPartWebSearchToolResult,
+)
+from .messages_response_stop_reason import MessagesResponseStopReason
+from .messages_response_stream_message_delta import MessagesResponseStreamMessageDelta
+from .messages_response_stream_message_delta_delta import (
+    MessagesResponseStreamMessageDeltaDelta,
+)
+from .messages_response_stream_message_start import MessagesResponseStreamMessageStart
+from .messages_response_stream_message_start_message import (
+    MessagesResponseStreamMessageStartMessage,
+)
+from .messages_response_stream_message_stop import MessagesResponseStreamMessageStop
+from .messages_role import MessagesRole
+from .messages_server_tool_caller import MessagesServerToolCaller
+from .messages_server_tool_usage import MessagesServerToolUsage
+from .messages_service_status import MessagesServiceStatus
+from .messages_stop_sequences import MessagesStopSequences
+from .messages_stream_event import MessagesStreamEvent
+from .messages_stream_options import MessagesStreamOptions
+from .messages_system import MessagesSystem
+from .messages_system_text_part import MessagesSystemTextPart
+from .messages_thinking import MessagesThinking
+from .messages_tool import MessagesTool
+from .messages_tool_choice import MessagesToolChoice
+from .messages_tool_choice_any import MessagesToolChoiceAny
+from .messages_tool_choice_auto import MessagesToolChoiceAuto
+from .messages_tool_choice_none import MessagesToolChoiceNone
+from .messages_tool_choice_tool import MessagesToolChoiceTool
+from .messages_tool_result_content import MessagesToolResultContent
+from .messages_tool_result_content_part import MessagesToolResultContentPart
+from .messages_tool_user_location import MessagesToolUserLocation
+from .messages_usage import MessagesUsage
+from .messages_web_search_result import MessagesWebSearchResult
+from .messages_web_search_tool_result_content import MessagesWebSearchToolResultContent
+from .messages_web_search_tool_result_error import MessagesWebSearchToolResultError
+from .model_fallback_status import ModelFallbackStatus
+
+__all__ = [
+    "Content",
+    "ContentBlockStart",
+    "ContentBlockStartContentBlock",
+    "CountTokensResponse",
+    "Error",
+    "MessagesContentPart",
+    "MessagesContentPartDocument",
+    "MessagesContentPartDocumentSource",
+    "MessagesContentPartImage",
+    "MessagesContentPartImageSource",
+    "MessagesContentPartServerToolUse",
+    "MessagesContentPartText",
+    "MessagesContentPartThinking",
+    "MessagesContentPartToolReference",
+    "MessagesContentPartToolResult",
+    "MessagesContentPartToolUse",
+    "MessagesContentPartWebSearchToolResult",
+    "MessagesContextManagement",
+    "MessagesContextManagementClearThinking",
+    "MessagesContextManagementClearToolUses",
+    "MessagesContextManagementClearToolUsesTrigger",
+    "MessagesContextManagementEdit",
+    "MessagesContextManagementKeep",
+    "MessagesContextManagementKeepAll",
+    "MessagesContextManagementKeepThinkingTurns",
+    "MessagesContextManagementKeepToolUses",
+    "MessagesDocumentSourceType",
+    "MessagesErrorResponse",
+    "MessagesImageSourceType",
+    "MessagesIterationUsage",
+    "MessagesMessageContent",
+    "MessagesMetadata",
+    "MessagesOutputConfig",
+    "MessagesOutputFormat",
+    "MessagesOutputFormatType",
+    "MessagesRequest",
+    "MessagesRequestMessage",
+    "MessagesRequestServiceTier",
+    "MessagesResponse",
+    "MessagesResponseContentBlock",
+    "MessagesResponseContentBlockDelta",
+    "MessagesResponseContentBlockDeltaSignature",
+    "MessagesResponseContentBlockDeltaText",
+    "MessagesResponseContentBlockDeltaThinking",
+    "MessagesResponseContentBlockDeltaToolUse",
+    "MessagesResponseContentBlockStop",
+    "MessagesResponseContentPart",
+    "MessagesResponseContentPartServerToolUse",
+    "MessagesResponseContentPartText",
+    "MessagesResponseContentPartThinking",
+    "MessagesResponseContentPartToolUse",
+    "MessagesResponseContentPartWebSearchToolResult",
+    "MessagesResponseStopReason",
+    "MessagesResponseStreamMessageDelta",
+    "MessagesResponseStreamMessageDeltaDelta",
+    "MessagesResponseStreamMessageStart",
+    "MessagesResponseStreamMessageStartMessage",
+    "MessagesResponseStreamMessageStop",
+    "MessagesRole",
+    "MessagesServerToolCaller",
+    "MessagesServerToolUsage",
+    "MessagesServiceStatus",
+    "MessagesStopSequences",
+    "MessagesStreamEvent",
+    "MessagesStreamOptions",
+    "MessagesSystem",
+    "MessagesSystemTextPart",
+    "MessagesThinking",
+    "MessagesTool",
+    "MessagesToolChoice",
+    "MessagesToolChoiceAny",
+    "MessagesToolChoiceAuto",
+    "MessagesToolChoiceNone",
+    "MessagesToolChoiceTool",
+    "MessagesToolResultContent",
+    "MessagesToolResultContentPart",
+    "MessagesToolUserLocation",
+    "MessagesUsage",
+    "MessagesWebSearchResult",
+    "MessagesWebSearchToolResultContent",
+    "MessagesWebSearchToolResultError",
+    "ModelFallbackStatus",
+]
+
+# Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py).
+from ._init_extras_shim import *  # noqa: F401,F403

arkruntime-0.3.0/src/arkruntime/types/messages/_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 messages 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-0.3.0/src/arkruntime/types/messages/content.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 arkruntime._models import BaseModel
+
+
+class Content(BaseModel):
+    """
+    Inline document content when `type` is `content`.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/content_block_start.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 Literal
+
+from arkruntime._models import BaseModel
+
+from .content_block_start_content_block import ContentBlockStartContentBlock
+
+
+class ContentBlockStart(BaseModel):
+    type: Literal["content_block_start"]
+    index: int
+    content_block: ContentBlockStartContentBlock

arkruntime-0.3.0/src/arkruntime/types/messages/content_block_start_content_block.py

@@ -0,0 +1,36 @@
+# 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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .messages_response_content_part_server_tool_use import (
+    MessagesResponseContentPartServerToolUse,
+)
+from .messages_response_content_part_text import MessagesResponseContentPartText
+from .messages_response_content_part_thinking import MessagesResponseContentPartThinking
+from .messages_response_content_part_tool_use import MessagesResponseContentPartToolUse
+from .messages_response_content_part_web_search_tool_result import (
+    MessagesResponseContentPartWebSearchToolResult,
+)
+
+ContentBlockStartContentBlock = TypeAliasType(
+    "ContentBlockStartContentBlock",
+    Annotated[
+        Union[
+            MessagesResponseContentPartText,
+            MessagesResponseContentPartThinking,
+            MessagesResponseContentPartToolUse,
+            MessagesResponseContentPartServerToolUse,
+            MessagesResponseContentPartWebSearchToolResult,
+        ],
+        Field(discriminator="type"),
+    ],
+)

arkruntime-0.3.0/src/arkruntime/types/messages/count_tokens_response.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 arkruntime._models import BaseModel
+
+
+class CountTokensResponse(BaseModel):
+    """
+    Token count for a Messages request.
+    """
+
+    input_tokens: int

arkruntime-0.3.0/src/arkruntime/types/messages/error.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 arkruntime._models import BaseModel
+
+
+class Error(BaseModel):
+    code: str
+    """
+    A machine-readable error code.
+    """
+    message: str
+    """
+    A human-readable description of the error.
+    """
+    param: str
+    """
+    The parameter that caused the error, if applicable.
+    """
+    type: str
+    """
+    The error type.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part.py

@@ -0,0 +1,40 @@
+# 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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .messages_content_part_document import MessagesContentPartDocument
+from .messages_content_part_image import MessagesContentPartImage
+from .messages_content_part_server_tool_use import MessagesContentPartServerToolUse
+from .messages_content_part_text import MessagesContentPartText
+from .messages_content_part_thinking import MessagesContentPartThinking
+from .messages_content_part_tool_result import MessagesContentPartToolResult
+from .messages_content_part_tool_use import MessagesContentPartToolUse
+from .messages_content_part_web_search_tool_result import (
+    MessagesContentPartWebSearchToolResult,
+)
+
+MessagesContentPart = TypeAliasType(
+    "MessagesContentPart",
+    Annotated[
+        Union[
+            MessagesContentPartText,
+            MessagesContentPartThinking,
+            MessagesContentPartImage,
+            MessagesContentPartDocument,
+            MessagesContentPartToolUse,
+            MessagesContentPartToolResult,
+            MessagesContentPartServerToolUse,
+            MessagesContentPartWebSearchToolResult,
+        ],
+        Field(discriminator="type"),
+    ],
+)

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_document.py

@@ -0,0 +1,21 @@
+# 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 .messages_content_part_document_source import MessagesContentPartDocumentSource
+
+
+class MessagesContentPartDocument(BaseModel):
+    type: Literal["document"]
+    """
+    The type of the content part. Always `document`.
+    """
+    source: MessagesContentPartDocumentSource

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_document_source.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 Optional
+
+from arkruntime._models import BaseModel
+
+from .content import Content
+from .messages_document_source_type import MessagesDocumentSourceType
+
+
+class MessagesContentPartDocumentSource(BaseModel):
+    type: MessagesDocumentSourceType
+    """
+    How the document is supplied.
+    """
+    url: Optional[str] = None
+    """
+    A URL of the document when `type` is `url`.
+    """
+    data: Optional[str] = None
+    """
+    Document data for `base64` and `text` sources.
+    """
+    content: Optional[Content] = None
+    """
+    Inline document content when `type` is `content`.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_image.py

@@ -0,0 +1,21 @@
+# 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 .messages_content_part_image_source import MessagesContentPartImageSource
+
+
+class MessagesContentPartImage(BaseModel):
+    type: Literal["image"]
+    """
+    The type of the content part. Always `image`.
+    """
+    source: MessagesContentPartImageSource

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_image_source.py

@@ -0,0 +1,40 @@
+# 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 .messages_image_source_type import MessagesImageSourceType
+
+
+class MessagesContentPartImageSource(BaseModel):
+    type: MessagesImageSourceType
+    """
+    How the image is supplied.
+    """
+    url: Optional[str] = None
+    """
+    A URL of the image when `type` is `url`.
+    """
+    media_type: Optional[str] = None
+    """
+    The media type of base64-encoded image data.
+    """
+    data: Optional[str] = None
+    """
+    Base64-encoded image data when `type` is `base64`.
+    """
+    file_id: Optional[str] = None
+    """
+    The blob id of an image uploaded out-of-band.
+    """
+    is_frame: Optional[bool] = None
+    """
+    Whether this image was extracted from a document or video.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_server_tool_use.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, Literal
+
+from arkruntime._models import BaseModel
+
+
+class MessagesContentPartServerToolUse(BaseModel):
+    type: Literal["server_tool_use"]
+    """
+    The type of the content part. Always `server_tool_use`.
+    """
+    id: str
+    """
+    The public id of the server-managed tool invocation.
+    """
+    name: str
+    """
+    The name of the invoked server-managed tool.
+    """
+    input: Dict[str, object]
+    """
+    The input generated for the tool.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_text.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 Literal
+
+from arkruntime._models import BaseModel
+
+
+class MessagesContentPartText(BaseModel):
+    type: Literal["text"]
+    """
+    The type of the content part. Always `text`.
+    """
+    text: str
+    """
+    The text content.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_thinking.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, Optional
+
+from arkruntime._models import BaseModel
+
+
+class MessagesContentPartThinking(BaseModel):
+    type: Literal["thinking"]
+    """
+    The type of the content part. Always `thinking`.
+    """
+    thinking: Optional[str] = None
+    """
+    The model's thinking content.
+    """
+    signature: Optional[str] = None
+    """
+    An opaque signature used to replay thinking content.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_tool_reference.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 Literal
+
+from arkruntime._models import BaseModel
+
+
+class MessagesContentPartToolReference(BaseModel):
+    type: Literal["tool_reference"]
+    """
+    The type of the content part. Always `tool_reference`.
+    """
+    tool_name: str
+    """
+    The referenced tool name.
+    """

arkruntime-0.3.0/src/arkruntime/types/messages/messages_content_part_tool_result.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 Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .messages_tool_result_content import MessagesToolResultContent
+
+
+class MessagesContentPartToolResult(BaseModel):
+    type: Literal["tool_result"]
+    """
+    The type of the content part. Always `tool_result`.
+    """
+    tool_use_id: str
+    """
+    The tool invocation this result answers.
+    """
+    content: MessagesToolResultContent
+    """
+    The content returned by the tool.
+    """
+    is_error: Optional[bool] = None
+    """
+    Whether the tool execution failed.
+    """