From fb12e81c26fc3ff3448e33052d4d6e254aa013e4 Mon Sep 17 00:00:00 2001 From: "ark-hand[bot]" Date: Mon, 16 Nov 2026 03:36:34 +0000 Subject: [PATCH] chore: sync from ark-apis fdcf8f13e9 Auto-generated SDK sync from ark-apis at fdcf8f13e92c7c4047f8f1ba2109eba1a40d4177. Generated files are overwritten by the sync pipeline and should not be edited by hand. Sync-Source-Commit: e15a98be1915de42af416d35f8c04590cc654c53 Ark-APIs-Commit: fdcf8f13e92c7c4047f8f1ba2109eba1a40d4177 Release-Version: 0.20.0 --- VERSION | 2 +- pyproject.toml | 2 +- src/arkruntime/resources/chat/completions.py | 4 +++ .../types/chat/chat_completion_request.py | 4 +++ .../chat/chat_completion_request_param.py | 3 ++ ...tent_block_start_content_block_thinking.py | 4 +++ .../types/messages/messages_metadata.py | 4 ++- src/arkruntime/types/responses/__init__.py | 3 ++ .../types/responses/item_reasoning.py | 2 +- .../types/responses/item_reasoning_param.py | 2 +- src/arkruntime/types/responses/response.py | 3 ++ .../types/responses/responses_request.py | 3 ++ .../responses/responses_request_param.py | 1 + .../types/responses/web_search_filters.py | 31 +++++++++++++++++++ .../responses/web_search_filters_param.py | 29 +++++++++++++++++ .../types/responses/web_search_source.py | 1 + .../types/responses/web_search_tool.py | 11 +++++++ .../types/responses/web_search_tool_param.py | 11 +++++++ uv.lock | 2 +- 19 files changed, 116 insertions(+), 6 deletions(-) create mode 100644 src/arkruntime/types/responses/web_search_filters.py create mode 100644 src/arkruntime/types/responses/web_search_filters_param.py diff --git a/VERSION b/VERSION index 1cf0537..5a03fb7 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.19.0 +0.20.0 diff --git a/pyproject.toml b/pyproject.toml index b4f5306..3fc8fb0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "arkruntime" -version = "0.19.0" +version = "0.20.0" description = "Ark runtime SDK for Python" readme = "README.md" requires-python = ">=3.8" diff --git a/src/arkruntime/resources/chat/completions.py b/src/arkruntime/resources/chat/completions.py index 280a108..c4bb658 100644 --- a/src/arkruntime/resources/chat/completions.py +++ b/src/arkruntime/resources/chat/completions.py @@ -80,6 +80,7 @@ def create( tools: Optional[List[ChatCompletionToolParam]] = None, parallel_tool_calls: Optional[bool] = None, user: Optional[str] = None, + prompt_cache_key: Optional[str] = None, service_tier: Optional[RequestServiceTier] = None, reasoning_effort: Optional[ReasoningEffort] = None, thinking: Optional[ThinkingParam] = None, @@ -114,6 +115,7 @@ def create( "tools": tools, "parallel_tool_calls": parallel_tool_calls, "user": user, + "prompt_cache_key": prompt_cache_key, "service_tier": service_tier, "reasoning_effort": reasoning_effort, "thinking": thinking, @@ -167,6 +169,7 @@ async def create( tools: Optional[List[ChatCompletionToolParam]] = None, parallel_tool_calls: Optional[bool] = None, user: Optional[str] = None, + prompt_cache_key: Optional[str] = None, service_tier: Optional[RequestServiceTier] = None, reasoning_effort: Optional[ReasoningEffort] = None, thinking: Optional[ThinkingParam] = None, @@ -201,6 +204,7 @@ async def create( "tools": tools, "parallel_tool_calls": parallel_tool_calls, "user": user, + "prompt_cache_key": prompt_cache_key, "service_tier": service_tier, "reasoning_effort": reasoning_effort, "thinking": thinking, diff --git a/src/arkruntime/types/chat/chat_completion_request.py b/src/arkruntime/types/chat/chat_completion_request.py index 43193c9..2ee43fd 100644 --- a/src/arkruntime/types/chat/chat_completion_request.py +++ b/src/arkruntime/types/chat/chat_completion_request.py @@ -115,6 +115,10 @@ class ChatCompletionRequest(BaseModel): """ A unique identifier representing your end-user. """ + prompt_cache_key: Optional[str] = None + """ + A routing hint for prompt cache affinity. + """ service_tier: Optional[RequestServiceTier] = None """ The service tier to use for the request. diff --git a/src/arkruntime/types/chat/chat_completion_request_param.py b/src/arkruntime/types/chat/chat_completion_request_param.py index 4181aad..6459fdb 100644 --- a/src/arkruntime/types/chat/chat_completion_request_param.py +++ b/src/arkruntime/types/chat/chat_completion_request_param.py @@ -112,6 +112,9 @@ class ChatCompletionRequestParam(TypedDict, total=False): user: Optional[str] """A unique identifier representing your end-user.""" + prompt_cache_key: Optional[str] + """A routing hint for prompt cache affinity.""" + service_tier: Optional[RequestServiceTier] """The service tier to use for the request.""" diff --git a/src/arkruntime/types/messages/content_block_start_content_block_thinking.py b/src/arkruntime/types/messages/content_block_start_content_block_thinking.py index 101ec6c..071a910 100644 --- a/src/arkruntime/types/messages/content_block_start_content_block_thinking.py +++ b/src/arkruntime/types/messages/content_block_start_content_block_thinking.py @@ -14,3 +14,7 @@ class ContentBlockStartContentBlockThinking(BaseModel): type: Literal["thinking"] thinking: Optional[str] = None + signature: Optional[str] = None + """ + Initial signature placeholder. May be empty; signature deltas provide the final value. + """ diff --git a/src/arkruntime/types/messages/messages_metadata.py b/src/arkruntime/types/messages/messages_metadata.py index bb65428..37b6d7c 100644 --- a/src/arkruntime/types/messages/messages_metadata.py +++ b/src/arkruntime/types/messages/messages_metadata.py @@ -14,5 +14,7 @@ class MessagesMetadata(BaseModel): user_id: Optional[str] = None """ - An external identifier for the user associated with the request. + An external identifier for the user associated with the request. When + set to a JSON object string containing a non-empty `session_id` string, + `session_id` is used as a routing hint for prompt cache affinity. """ diff --git a/src/arkruntime/types/responses/__init__.py b/src/arkruntime/types/responses/__init__.py index 4e887e4..c955c4d 100644 --- a/src/arkruntime/types/responses/__init__.py +++ b/src/arkruntime/types/responses/__init__.py @@ -264,6 +264,7 @@ from .url_citation import UrlCitation from .user_location import UserLocation from .web_search_action import WebSearchAction +from .web_search_filters import WebSearchFilters from .web_search_source import WebSearchSource from .web_search_tool import WebSearchTool @@ -458,6 +459,7 @@ "UrlCitation", "UserLocation", "WebSearchAction", + "WebSearchFilters", "WebSearchSource", "WebSearchTool", ] @@ -539,6 +541,7 @@ from .typed_tool_choice_param import TypedToolChoiceParam from .url_citation_param import UrlCitationParam from .user_location_param import UserLocationParam +from .web_search_filters_param import WebSearchFiltersParam from .web_search_tool_param import WebSearchToolParam # Hand-written extras (preserved across regen via Makefile rsync --exclude=*_shim.py). diff --git a/src/arkruntime/types/responses/item_reasoning.py b/src/arkruntime/types/responses/item_reasoning.py index b58e887..3ab73c0 100644 --- a/src/arkruntime/types/responses/item_reasoning.py +++ b/src/arkruntime/types/responses/item_reasoning.py @@ -18,7 +18,7 @@ class ItemReasoning(BaseModel): id: Optional[str] = None type: Literal["reasoning"] - status: ItemStatus + status: Optional[ItemStatus] = None summary: Optional[List[ReasoningSummaryPart]] = None content: Optional[List[OutputContentItem]] = None encrypted_content: Optional[str] = None diff --git a/src/arkruntime/types/responses/item_reasoning_param.py b/src/arkruntime/types/responses/item_reasoning_param.py index 3fee72e..be99f9e 100644 --- a/src/arkruntime/types/responses/item_reasoning_param.py +++ b/src/arkruntime/types/responses/item_reasoning_param.py @@ -20,7 +20,7 @@ class ItemReasoningParam(TypedDict, total=False): type: Required[Literal["reasoning"]] - status: Required[ItemStatus] + status: Optional[ItemStatus] summary: Optional[List[ReasoningSummaryPartParam]] diff --git a/src/arkruntime/types/responses/response.py b/src/arkruntime/types/responses/response.py index 3e1c8ef..bfeac23 100644 --- a/src/arkruntime/types/responses/response.py +++ b/src/arkruntime/types/responses/response.py @@ -56,3 +56,6 @@ class Response(BaseModel): session: Optional[Session] = None safety_identifier: Optional[str] = None prompt_cache_key: Optional[str] = None + """ + A routing hint for prompt cache affinity. + """ diff --git a/src/arkruntime/types/responses/responses_request.py b/src/arkruntime/types/responses/responses_request.py index 9fac7bd..88e39d6 100644 --- a/src/arkruntime/types/responses/responses_request.py +++ b/src/arkruntime/types/responses/responses_request.py @@ -47,4 +47,7 @@ class ResponsesRequest(BaseModel): context_management: Optional[ContextManagement] = None session: Optional[Session] = None prompt_cache_key: Optional[str] = None + """ + A routing hint for prompt cache affinity. + """ safety_identifier: Optional[str] = None diff --git a/src/arkruntime/types/responses/responses_request_param.py b/src/arkruntime/types/responses/responses_request_param.py index 6bf9ccf..bc427e9 100644 --- a/src/arkruntime/types/responses/responses_request_param.py +++ b/src/arkruntime/types/responses/responses_request_param.py @@ -69,5 +69,6 @@ class ResponsesRequestParam(TypedDict, total=False): session: Optional[SessionParam] prompt_cache_key: Optional[str] + """A routing hint for prompt cache affinity.""" safety_identifier: Optional[str] diff --git a/src/arkruntime/types/responses/web_search_filters.py b/src/arkruntime/types/responses/web_search_filters.py new file mode 100644 index 0000000..4d1dd6a --- /dev/null +++ b/src/arkruntime/types/responses/web_search_filters.py @@ -0,0 +1,31 @@ +# Generated by datamodel-code-generator from ark-apis typespec/openapi. +# DO NOT EDIT — regenerate with `make gen-py-` 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 + + +class WebSearchFilters(BaseModel): + """ + Per-search restrictions applied by the doubao source. + """ + + allowed_domains: Optional[List[str]] = None + """ + Full domains the search is restricted to. At most 20. + """ + blocked_domains: Optional[List[str]] = None + """ + Full domains excluded from the search. At most 5. + """ + auth_info_level: Optional[int] = None + """ + 0 (default) does not restrict authority; 1 returns only very + authoritative content, which may reduce the number of results. + """ diff --git a/src/arkruntime/types/responses/web_search_filters_param.py b/src/arkruntime/types/responses/web_search_filters_param.py new file mode 100644 index 0000000..f624829 --- /dev/null +++ b/src/arkruntime/types/responses/web_search_filters_param.py @@ -0,0 +1,29 @@ +# Generated by datamodel-code-generator from ark-apis typespec/openapi. +# DO NOT EDIT — regenerate with `make gen-py-` 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 TypedDict + + +class WebSearchFiltersParam(TypedDict, total=False): + """ + Per-search restrictions applied by the doubao source. + """ + + allowed_domains: Optional[List[str]] + """Full domains the search is restricted to. At most 20.""" + + blocked_domains: Optional[List[str]] + """Full domains excluded from the search. At most 5.""" + + auth_info_level: Optional[int] + """ + 0 (default) does not restrict authority; 1 returns only very + authoritative content, which may reduce the number of results. + """ diff --git a/src/arkruntime/types/responses/web_search_source.py b/src/arkruntime/types/responses/web_search_source.py index 930b134..5ff2546 100644 --- a/src/arkruntime/types/responses/web_search_source.py +++ b/src/arkruntime/types/responses/web_search_source.py @@ -14,3 +14,4 @@ class WebSearchSource(str, Enum): douyin = "douyin" moji = "moji" search_engine = "search_engine" + doubao = "doubao" diff --git a/src/arkruntime/types/responses/web_search_tool.py b/src/arkruntime/types/responses/web_search_tool.py index fe1d383..088c2a8 100644 --- a/src/arkruntime/types/responses/web_search_tool.py +++ b/src/arkruntime/types/responses/web_search_tool.py @@ -11,6 +11,7 @@ from arkruntime._models import BaseModel from .user_location import UserLocation +from .web_search_filters import WebSearchFilters from .web_search_source import WebSearchSource @@ -20,3 +21,13 @@ class WebSearchTool(BaseModel): user_location: Optional[UserLocation] = None sources: Optional[List[WebSearchSource]] = None max_keyword: Optional[int] = None + filters: Optional[WebSearchFilters] = None + """ + Domain and authority filters. Only supported with the doubao source. + """ + time_range: Optional[str] = None + """ + Publish time range of the results: `OneDay`, `OneWeek`, `OneMonth`, + `OneYear`, or an inclusive date range `YYYY-MM-DD..YYYY-MM-DD`. Empty + means unrestricted. Only supported with the doubao source. + """ diff --git a/src/arkruntime/types/responses/web_search_tool_param.py b/src/arkruntime/types/responses/web_search_tool_param.py index 95527b2..c2ad9e2 100644 --- a/src/arkruntime/types/responses/web_search_tool_param.py +++ b/src/arkruntime/types/responses/web_search_tool_param.py @@ -11,6 +11,7 @@ from typing_extensions import Required, TypedDict from .user_location_param import UserLocationParam +from .web_search_filters_param import WebSearchFiltersParam from .web_search_source import WebSearchSource @@ -24,3 +25,13 @@ class WebSearchToolParam(TypedDict, total=False): sources: Optional[List[WebSearchSource]] max_keyword: Optional[int] + + filters: Optional[WebSearchFiltersParam] + """Domain and authority filters. Only supported with the doubao source.""" + + time_range: Optional[str] + """ + Publish time range of the results: `OneDay`, `OneWeek`, `OneMonth`, + `OneYear`, or an inclusive date range `YYYY-MM-DD..YYYY-MM-DD`. Empty + means unrestricted. Only supported with the doubao source. + """ diff --git a/uv.lock b/uv.lock index 5172c5e..944874f 100644 --- a/uv.lock +++ b/uv.lock @@ -79,7 +79,7 @@ wheels = [ [[package]] name = "arkruntime" -version = "0.19.0" +version = "0.20.0" source = { editable = "." } dependencies = [ { name = "anyio", version = "4.5.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },