volcengine-python-sdk 4.0.29__py2.py3-none-any.whl → 4.0.31__py2.py3-none-any.whl

volcenginesdkarkruntime/types/responses/response.py

@@ -1,4 +1,3 @@
-
 # Copyright (c) [2025] [OpenAI]
 # Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
 # SPDX-License-Identifier: Apache-2.0
@@ -10,51 +9,53 @@
 #
 # This modified file is released under the same license.
 
-from typing import List, Union, Optional
+from typing import List, Optional, Union
+
 from typing_extensions import Literal, TypeAlias
+from volcenginesdkarkruntime.types.shared.reasoning import Reasoning
+from volcenginesdkarkruntime.types.shared.thinking import Thinking
 
-from .tool import Tool
 from ..._models import BaseModel
+from .response_caching import ResponseCaching
 from .response_error import ResponseError
-from .response_usage import ResponseUsage
-from .response_status import ResponseStatus
-from volcenginesdkarkruntime.types.shared.thinking import Thinking
-from .tool_choice_options import ToolChoiceOptions
+from .response_incomplete_details import IncompleteDetails
 from .response_output_item import ResponseOutputItem
 from .response_text_config import ResponseTextConfig
+from .response_usage import ResponseUsage
+from .tool import Tool
 from .tool_choice_function import ToolChoiceFunction
-from .response_incomplete_details import IncompleteDetails
-from .response_caching import ResponseCaching
-
+from .tool_choice_knowledge_search import ToolChoiceKnowledgeSearch
+from .tool_choice_mcp import ToolChoiceMcp
+from .tool_choice_options import ToolChoiceOptions
+from .tool_choice_web_search import ToolChoiceWebSearch
 
 __all__ = ["Response", "ToolChoice"]
 
 
-ToolChoice: TypeAlias = Union[ToolChoiceOptions, ToolChoiceFunction]
+ToolChoice: TypeAlias = Union[
+    ToolChoiceOptions,
+    ToolChoiceFunction,
+    ToolChoiceMcp,
+    ToolChoiceWebSearch,
+    ToolChoiceKnowledgeSearch,
+]
 
 
 class Response(BaseModel):
-    id: str
-    """Unique identifier for this Response."""
-
-    created_at: float
+    created_at: int
     """Unix timestamp (in seconds) of when this Response was created."""
 
     error: Optional[ResponseError] = None
     """An error object returned when the model fails to generate a Response."""
 
+    id: str
+    """Unique identifier for this Response."""
+
     incomplete_details: Optional[IncompleteDetails] = None
     """Details about why the response is incomplete."""
 
-    instructions: Optional[str] = None
-    """
-    Inserts a system (or developer) message as the first item in the model's
-    context.
-
-    When using along with `previous_response_id`, the instructions from a previous
-    response will not be carried over to the next response. This makes it simple to
-    swap out system (or developer) messages in new responses.
-    """
+    max_output_tokens: Optional[int] = None
+    """An upper bound for the number of tokens that can be generated for a response."""
 
     model: str
     """Model Name or endpoint id."""
@@ -63,90 +64,55 @@ class Response(BaseModel):
     """The object type of this resource - always set to `response`."""
 
     output: List[ResponseOutputItem]
-    """An array of content items generated by the model.
+    """An array of content items generated by the model."""
 
-    - The length and order of items in the `output` array is dependent on the
-      model's response.
-    - Rather than accessing the first item in the `output` array and assuming it's
-      an `assistant` message with the content generated by the model, you might
-      consider using the `output_text` property where supported in SDKs.
-    """
+    previous_response_id: Optional[str] = None
+    """The unique ID of the previous response to the model. Use this to create multi-turn conversations."""
 
-    parallel_tool_calls: bool
-    """Whether to allow the model to run tool calls in parallel."""
+    thinking: Optional[Thinking] = None
+    """The thinking mode to use for the model."""
 
-    temperature: Optional[float] = None
-    """What sampling temperature to use, between 0 and 2.
+    service_tier: Optional[Literal["auto", "default"]] = None
+    """Specifies the latency tier to use for processing the request."""
 
-    Higher values like 0.8 will make the output more random, while lower values like
-    0.2 will make it more focused and deterministic. We generally recommend altering
-    this or `top_p` but not both.
-    """
+    status: Literal["in_progress", "completed", "incomplete", "failed"]
+    """The status of the response generation.  One of `completed`, `failed`, `in_progress`, or `incomplete`."""
 
-    tool_choice: ToolChoice
-    """
-    How the model should select which tool (or tools) to use when generating a
-    response. See the `tools` parameter to see how to specify which tools the model
-    can call.
-    """
+    temperature: Optional[float] = None
+    """What sampling temperature to use, between 0 and 2."""
 
     tools: List[Tool]
-    """
-    An array of tools the model may call while generating a response.
-
-    You can specify which tool to use by setting the `tool_choice` parameter.
-    """
+    """An array of tools the model may call while generating a response. You can specify which tool to use by setting the `tool_choice` parameter."""
 
     top_p: Optional[float] = None
-    """
-    An alternative to sampling with temperature, called nucleus sampling, where the
-    model considers the results of the tokens with top_p probability mass. So 0.1
-    means only the tokens comprising the top 10% probability mass are considered.
-
-    We generally recommend altering this or `temperature` but not both.
-    """
+    """An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered."""
 
-    max_output_tokens: Optional[int] = None
-    """
-    An upper bound for the number of tokens that can be generated for a response.
-    """
-
-    previous_response_id: Optional[str] = None
-    """The unique ID of the previous response to the model.
-
-    Use this to create multi-turn conversations.
-    """
+    usage: Optional[ResponseUsage] = None
+    """Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used."""
 
-    thinking: Optional[Thinking] = None
-    """
-    The thinking mode to use for the model.
-    """
+    caching: Optional[ResponseCaching] = None
+    """Represents the caching configuration for the response."""
 
-    service_tier: Optional[Literal["auto", "default"]] = None
-    """
-    Specifies the latency tier to use for processing the request.
-    """
+    text: Optional[ResponseTextConfig] = None
+    """Configuration options for a text response from the model. Can be plain text or json object"""
 
-    status: Optional[ResponseStatus] = None
-    """The status of the response generation.
+    instructions: Optional[str] = None
+    """Inserts a system (or developer) message as the first item in the model's context."""
 
-    One of `completed`, `failed`, `in_progress`, or `incomplete`.
-    """
+    store: Optional[bool] = None
+    """Whether to store the response object"""
 
-    text: Optional[ResponseTextConfig] = None
-    """Configuration options for a text response from the model.
+    expire_at: Optional[int] = None
+    """The expiration time of the response object"""
 
-    Can be plain text or json object
+    tool_choice: Optional[ToolChoice] = None
+    """How the model should select which tool (or tools) to use when generating a response. See the `tools` parameter to see how to specify which tools the model can call."""
 
-    """
+    parallel_tool_calls: Optional[bool] = None
+    """Whether to allow the model to run tool calls in parallel."""
 
-    usage: Optional[ResponseUsage] = None
-    """
-    Represents token usage details including input tokens, output tokens, a
-    breakdown of output tokens, and the total tokens used.
-    """
+    max_tool_calls: Optional[int] = None
+    """The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored."""
 
-    caching: Optional[ResponseCaching] = None
-    """
-    Represents the caching configuration for the response.
-    """
+    reasoning: Optional[Reasoning] = None
+    """Configuration options for reasoning models"""

volcenginesdkarkruntime/types/responses/response_annotation_added_event.py

@@ -1,4 +1,3 @@
-
 # Copyright (c) [2025] [OpenAI]
 # Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
 # SPDX-License-Identifier: Apache-2.0
@@ -10,27 +9,9 @@
 #
 # This modified file is released under the same license.
 
-from typing_extensions import Literal
 
-from ..._models import BaseModel
-from .response_output_text import ResponseOutputTextAnnotation
+from .response_output_text_annotation_added_event import (
+    ResponseOutputTextAnnotationAddedEvent,
+)
 
 __all__ = ["ResponseOutputTextAnnotationAddedEvent"]
-
-
-class ResponseOutputTextAnnotationAddedEvent(BaseModel):
-
-    item_id: str
-    """The ID of the item this event is associated with."""
-
-    output_index: int
-    """The index of the output item this event is associated with."""
-
-    type: Literal["response.output_text.annotation.added"]
-    """The type of the event. Always `response.annotation.added`."""
-
-    content_index: int
-    """The index of the content in the output content."""
-
-    annotation: ResponseOutputTextAnnotation
-    """The annotation added to the output content."""

volcenginesdkarkruntime/types/responses/response_caching.py

@@ -1,4 +1,3 @@
-
 # Copyright (c) [2025] [OpenAI]
 # Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
 # SPDX-License-Identifier: Apache-2.0
@@ -11,15 +10,16 @@
 # This modified file is released under the same license.
 
 from typing import Optional
+
 from typing_extensions import Literal
 
-from pydantic import BaseModel
+from ..._models import BaseModel
 
 __all__ = ["ResponseCaching"]
 
 
 class ResponseCaching(BaseModel):
-    type: Optional[Literal["enabled", "disabled"]]
-    """
-    Whether to enable caching.
-    """
+    type: Optional[Literal["disabled", "enabled"]] = None
+    """Whether to enable caching."""
+
+    prefix: Optional[bool] = None

volcenginesdkarkruntime/types/responses/response_caching_param.py

@@ -1,4 +1,3 @@
-
 # Copyright (c) [2025] [OpenAI]
 # Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
 # SPDX-License-Identifier: Apache-2.0
@@ -12,11 +11,15 @@
 
 from __future__ import annotations
 
-from typing_extensions import Literal, Required, TypedDict
+from typing import Optional
+
+from typing_extensions import Literal, TypedDict
 
 __all__ = ["ResponseCaching"]
 
 
 class ResponseCaching(TypedDict, total=False):
-    type: Required[Literal["disabled", "enabled"]]
-    """The type of caching."""
+    type: Optional[Literal["disabled", "enabled"]]
+    """Whether to enable caching."""
+
+    prefix: Optional[bool]

volcenginesdkarkruntime/types/responses/response_create_params.py

@@ -1,4 +1,3 @@
-
 # Copyright (c) [2025] [OpenAI]
 # Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
 # SPDX-License-Identifier: Apache-2.0
@@ -13,14 +12,23 @@
 from __future__ import annotations
 
 from typing import Union
+
 from typing_extensions import TypeAlias
 
-from .tool_choice_options import ToolChoiceOptions
 from .tool_choice_function_param import ToolChoiceFunctionParam
+from .tool_choice_knowledge_search_param import ToolChoiceKnowledgeSearchParam
 from .tool_choice_mcp_param import ToolChoiceMcpParam
+from .tool_choice_options import ToolChoiceOptions
+from .tool_choice_web_search_param import ToolChoiceWebSearchParam
 
 __all__ = [
     "ToolChoice",
 ]
 
-ToolChoice: TypeAlias = Union[ToolChoiceOptions, ToolChoiceFunctionParam, ToolChoiceMcpParam]
+ToolChoice: TypeAlias = Union[
+    ToolChoiceOptions,
+    ToolChoiceFunctionParam,
+    ToolChoiceMcpParam,
+    ToolChoiceWebSearchParam,
+    ToolChoiceKnowledgeSearchParam,
+]

volcenginesdkarkruntime/types/responses/response_image_process_action.py

@@ -0,0 +1,24 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessAction"]
+
+
+class ResponseImageProcessAction(BaseModel):
+    type: str
+
+    result_image_url: Optional[str] = None

volcenginesdkarkruntime/types/responses/response_image_process_args.py

@@ -0,0 +1,30 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing import Union
+
+from typing_extensions import TypeAlias
+
+from .response_image_process_grounding_args import ResponseImageProcessGroundingArgs
+from .response_image_process_point_args import ResponseImageProcessPointArgs
+from .response_image_process_rotate_args import ResponseImageProcessRotateArgs
+from .response_image_process_zoom_args import ResponseImageProcessZoomArgs
+
+__all__ = ["ResponseImageProcessArgs"]
+
+ResponseImageProcessArgs: TypeAlias = Union[
+    ResponseImageProcessPointArgs,
+    ResponseImageProcessGroundingArgs,
+    ResponseImageProcessRotateArgs,
+    ResponseImageProcessZoomArgs,
+]

volcenginesdkarkruntime/types/responses/response_image_process_call_completed_event.py

@@ -0,0 +1,35 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing import Optional
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .response_image_process_action import ResponseImageProcessAction
+from .response_image_process_args import ResponseImageProcessArgs
+from .response_image_process_error import ResponseImageProcessError
+
+__all__ = ["ResponseImageProcessCallCompletedEvent"]
+
+
+class ResponseImageProcessCallCompletedEvent(BaseModel):
+    type: Literal["response.image_process_call.completed"]
+
+    item_id: str
+
+    action: ResponseImageProcessAction
+
+    arguments: ResponseImageProcessArgs
+
+    error: Optional[ResponseImageProcessError] = None

volcenginesdkarkruntime/types/responses/response_image_process_call_in_progress_event.py

@@ -0,0 +1,24 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessCallInProgressEvent"]
+
+
+class ResponseImageProcessCallInProgressEvent(BaseModel):
+    type: Literal["response.image_process_call.in_progress"]
+
+    item_id: str

volcenginesdkarkruntime/types/responses/response_image_process_call_processing_event.py

@@ -0,0 +1,30 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .response_image_process_action import ResponseImageProcessAction
+from .response_image_process_args import ResponseImageProcessArgs
+
+__all__ = ["ResponseImageProcessCallProcessingEvent"]
+
+
+class ResponseImageProcessCallProcessingEvent(BaseModel):
+    type: Literal["response.image_process_call.progressing"]
+
+    item_id: str
+
+    action: ResponseImageProcessAction
+
+    arguments: ResponseImageProcessArgs

volcenginesdkarkruntime/types/responses/response_image_process_error.py

@@ -0,0 +1,20 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessError"]
+
+
+class ResponseImageProcessError(BaseModel):
+    message: str

volcenginesdkarkruntime/types/responses/response_image_process_grounding_args.py

@@ -0,0 +1,24 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessGroundingArgs"]
+
+
+class ResponseImageProcessGroundingArgs(BaseModel):
+    image_index: int
+
+    bbox_str: str
+
+    crop: bool

volcenginesdkarkruntime/types/responses/response_image_process_point_args.py

@@ -0,0 +1,24 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessPointArgs"]
+
+
+class ResponseImageProcessPointArgs(BaseModel):
+    image_index: int
+
+    points: str
+
+    drawLine: bool

volcenginesdkarkruntime/types/responses/response_image_process_rotate_args.py

@@ -0,0 +1,22 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessRotateArgs"]
+
+
+class ResponseImageProcessRotateArgs(BaseModel):
+    image_index: int
+
+    degree: int

volcenginesdkarkruntime/types/responses/response_image_process_zoom_args.py

@@ -0,0 +1,24 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from ..._models import BaseModel
+
+__all__ = ["ResponseImageProcessZoomArgs"]
+
+
+class ResponseImageProcessZoomArgs(BaseModel):
+    image_index: int
+
+    bbox_str: str
+
+    scale: float

volcenginesdkarkruntime/types/responses/response_input_audio.py

@@ -0,0 +1,33 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing import Optional
+
+from typing_extensions import Literal
+
+from ..._models import BaseModel
+from .audio_chunking_strategy import AudioChunkingStrategy
+
+__all__ = ["ResponseInputAudio"]
+
+
+class ResponseInputAudio(BaseModel):
+    type: Literal["input_audio"]
+
+    chunking_strategy: Optional[AudioChunkingStrategy] = None
+
+    audio_url: str
+
+    file_id: Optional[str] = None
+
+    audio_bytes: Optional[bytes] = None

volcenginesdkarkruntime/types/responses/response_input_audio_param.py

@@ -0,0 +1,32 @@
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from __future__ import annotations
+
+from typing import Optional
+
+from typing_extensions import Literal, Required, TypedDict
+
+from .audio_chunking_strategy_param import AudioChunkingStrategyParam
+
+__all__ = ["ResponseInputAudioParam"]
+
+
+class ResponseInputAudioParam(TypedDict, total=False):
+    type: Required[Literal["input_audio"]]
+
+    chunking_strategy: Optional[AudioChunkingStrategyParam]
+
+    audio_url: Required[str]
+
+    file_id: Optional[str]
+
+    audio_bytes: Optional[bytes]