【web_search】web_search

Author: jinhaiyang

tests/integration_tests/test_web_search.py

@@ -0,0 +1,24 @@
+from zhipuai import ZhipuAI
+import zhipuai
+
+import logging
+import logging.config
+
+
+def test_web_search(logging_conf):
+    logging.config.dictConfig(logging_conf)  # type: ignore
+    client = ZhipuAI()  # 填写您自己的APIKey
+    try:
+        response = client.web_search.web_search(
+            search_engine="search-std",
+            search_query="2025特朗普向中国加征了多少关税"
+        )
+        print(response)
+
+    except zhipuai.core._errors.APIRequestFailedError as err:
+        print(err)
+    except zhipuai.core._errors.APIInternalError as err:
+        print(err)
+    except zhipuai.core._errors.APIStatusError as err:
+        print(err)
+

zhipuai/_client.py

@@ -62,6 +62,7 @@ def __init__(
         self.tools = api_resource.Tools(self)
         self.videos = api_resource.Videos(self)
         self.assistant = api_resource.Assistant(self)
+        self.web_search = api_resource.WebSearchApi(self)
 
     @property
     @override

zhipuai/api_resource/__init__.py

@@ -34,6 +34,10 @@
     Assistant,
 )
 
+from .web_search import (
+    WebSearchApi
+)
+
 __all__ = [
     'Videos',
     'AsyncCompletions',

zhipuai/api_resource/web_search/__init__.py

@@ -0,0 +1,3 @@
+from .web_search import WebSearchApi
+
+__all__ = ['WebSearchApi']

zhipuai/api_resource/web_search/web_search.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, List, Union, Dict, Optional
+from ...types.sensitive_word_check import SensitiveWordCheckRequest
+from ...core import NOT_GIVEN, Body, Headers, NotGiven, BaseAPI, maybe_transform, StreamResponse, deepcopy_minimal
+
+import httpx
+
+from ...core import (
+    make_request_options,
+)
+import logging
+
+from ...types.web_search import web_search_create_params
+from ...types.web_search.web_search_resp import WebSearchResp
+
+logger = logging.getLogger(__name__)
+
+if TYPE_CHECKING:
+    from ..._client import ZhipuAI
+
+__all__ = ["WebSearchApi"]
+
+
+class WebSearchApi(BaseAPI):
+    def __init__(self, client: "ZhipuAI") -> None:
+        super().__init__(client)
+
+    def web_search(
+            self,
+            *,
+            request_id: Optional[str] | NotGiven = NOT_GIVEN,
+            search_engine: Optional[str] | NotGiven = NOT_GIVEN,
+            search_query: Optional[str] | NotGiven = NOT_GIVEN,
+            user_id: Optional[str] | NotGiven = NOT_GIVEN,
+            sensitive_word_check: Optional[SensitiveWordCheckRequest] | NotGiven = NOT_GIVEN,
+            extra_headers: Headers | None = None,
+            extra_body: Body | None = None,
+            timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
+    ) -> WebSearchResp:
+
+        body = deepcopy_minimal(
+            {
+                "request_id": request_id,
+                "search_engine": search_engine,
+                "search_query": search_query,
+                "user_id": user_id,
+                "sensitive_word_check": sensitive_word_check
+            })
+        return self._post(
+            "/web_search",
+            body= maybe_transform(body, web_search_create_params.WebSearchCreatParams),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_body=extra_body, timeout=timeout
+            ),
+            cast_type=WebSearchResp
+        )

zhipuai/types/web_search/__init__.py

@@ -0,0 +1,6 @@
+
+from .web_search_create_params import (
+    WebSearchCreatParams
+)
+
+__all__ = ["WebSearchCreatParams"]

zhipuai/types/web_search/web_search_create_params.py

@@ -0,0 +1,26 @@
+
+from __future__ import annotations
+
+from typing import Union, Optional, List
+from typing_extensions import Literal, Required, TypedDict
+from ...types.sensitive_word_check import SensitiveWordCheckRequest
+
+
+__all__ = ["WebSearchCreatParams"]
+
+
+class WebSearchCreatParams(TypedDict):
+
+    search_engine: str
+    """搜索引擎"""
+
+    search_query: str
+    """搜索query文本"""
+
+    request_id: str
+    """由用户端传参，需保证唯一性；用于区分每次请求的唯一标识，用户端不传时平台会默认生成。"""
+
+    user_id: str
+    """用户端。"""
+
+    sensitive_word_check: Optional[SensitiveWordCheckRequest]

zhipuai/types/web_search/web_search_params.py

@@ -0,0 +1,42 @@
+from typing import List, Optional
+
+from ...core import BaseModel
+
+__all__ = [
+    "SearchIntentResp",
+    "SearchResultResp",
+]
+
+
+class SearchIntentResp(BaseModel):
+    query: str
+    # 搜索优化 query
+    intent: str
+    # 判断的意图类型
+    keywords: str
+    # 搜索关键词
+
+
+class SearchResultResp(BaseModel):
+    index: int
+    # 搜索轮次，默认为 0
+    title: str
+    # 标题
+    link: str
+    # 链接
+    content: str
+    # 内容
+    icon: str
+    # 图标
+    media: str
+    # 来源媒体
+    refer: str
+    # 角标序号 [ref_1]
+
+class WebSearchResp(BaseModel):
+    created: Optional[int] = None
+    request_id: Optional[str] = None
+    id: Optional[str] = None
+    search_intents: Optional[SearchIntentResp]
+    search_results: Optional[SearchResultResp]
+