sensitive_word_check (#51)

Author: glide-the

tests/integration_tests/test_chat.py

@@ -454,5 +454,39 @@ def test_retrieve_completion_result(logging_conf):
         print(err)
 
 
-if __name__ == '__main__':
-    test_completions_temp0()
+def test_completions_sensitive_word_check(logging_conf):
+    logging.config.dictConfig(logging_conf)  # type: ignore
+    client = ZhipuAI()  # 填写您自己的APIKey
+    try:
+        # 生成request_id
+        request_id = time.time()
+        print(f"request_id:{request_id}")
+        response = client.chat.completions.create(
+            request_id=request_id,
+            model="glm-4",
+            messages=[
+                {
+                    "role": "user",
+                    "content": "tell me a joke"
+                }
+            ],
+            top_p=1,
+            temperature=0.9,
+            max_tokens=2000,
+            sensitive_word_check={
+                "type": "ALL",
+                "status": "DISABLE"
+            },
+            user_id="12345678"
+        )
+        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)
+

tests/integration_tests/test_images.py

@@ -19,6 +19,32 @@ def test_images(logging_conf):
 
 
 
+    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)
+
+
+def test_images_sensitive_word_check(logging_conf):
+    logging.config.dictConfig(logging_conf)  # type: ignore
+    client = ZhipuAI()  # 填写您自己的APIKey
+    try:
+        response = client.images.generations(
+            model="cogview-3", #填写需要调用的模型名称
+            prompt="一只可爱的小猫咪",
+            sensitive_word_check={
+                "type": "ALL",
+                "status": "DISABLE"
+            },
+            extra_body={"user_id": "1222212"},
+            user_id="12345678"
+        )
+        print(response)
+
+
+
     except zhipuai.core._errors.APIRequestFailedError as err:
         print(err)
     except zhipuai.core._errors.APIInternalError as err:

tests/integration_tests/test_videos.py

@@ -27,6 +27,31 @@ def test_videos(logging_conf):
         print(err)
 
 
+def test_videos_sensitive_word_check(logging_conf):
+    logging.config.dictConfig(logging_conf)  # type: ignore
+    client = ZhipuAI()  # 填写您自己的APIKey
+    try:
+        response = client.videos.generations(
+            model="cogvideo",
+            prompt="一个开船的人",
+            sensitive_word_check={
+                "type": "ALL",
+                "status": "DISABLE"
+            },
+            user_id="1212222"
+        )
+        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)
+
+
 def test_videos_image_url(logging_conf):
     logging.config.dictConfig(logging_conf)  # type: ignore
     client = ZhipuAI()  # 填写您自己的APIKey

zhipuai/api_resource/chat/async_completions.py

@@ -11,6 +11,7 @@
 from ...core import make_request_options
 from ...types.chat.async_chat_completion import AsyncTaskStatus, AsyncCompletion
 from ...types.chat.code_geex import code_geex_params
+from ...types.sensitive_word_check import SensitiveWordCheckRequest
 
 logger = logging.getLogger(__name__)
 
@@ -35,7 +36,7 @@ def create(
             seed: int | NotGiven = NOT_GIVEN,
             messages: Union[str, List[str], List[int], List[List[int]], None],
             stop: Optional[Union[str, List[str], None]] | NotGiven = NOT_GIVEN,
-            sensitive_word_check: Optional[object] | NotGiven = NOT_GIVEN,
+            sensitive_word_check: Optional[SensitiveWordCheckRequest] | NotGiven = NOT_GIVEN,
             tools: Optional[object] | NotGiven = NOT_GIVEN,
             tool_choice: str | NotGiven = NOT_GIVEN,
             meta: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,

zhipuai/api_resource/chat/completions.py

@@ -13,6 +13,7 @@
 from ...types.chat.chat_completion import Completion
 from ...types.chat.chat_completion_chunk import ChatCompletionChunk
 from ...types.chat.code_geex import code_geex_params
+from ...types.sensitive_word_check import SensitiveWordCheckRequest
 
 logger = logging.getLogger(__name__)
 
@@ -38,7 +39,7 @@ def create(
             seed: int | NotGiven = NOT_GIVEN,
             messages: Union[str, List[str], List[int], object, None],
             stop: Optional[Union[str, List[str], None]] | NotGiven = NOT_GIVEN,
-            sensitive_word_check: Optional[object] | NotGiven = NOT_GIVEN,
+            sensitive_word_check: Optional[SensitiveWordCheckRequest] | NotGiven = NOT_GIVEN,
             tools: Optional[object] | NotGiven = NOT_GIVEN,
             tool_choice: str | NotGiven = NOT_GIVEN,
             meta: Optional[Dict[str,str]] | NotGiven = NOT_GIVEN,

zhipuai/api_resource/images.py

@@ -8,6 +8,7 @@
 from ..core import NotGiven, NOT_GIVEN, Headers, Body
 from ..core import make_request_options
 from ..types.image import ImagesResponded
+from ..types.sensitive_word_check import SensitiveWordCheckRequest
 
 if TYPE_CHECKING:
     from .._client import ZhipuAI
@@ -27,6 +28,7 @@ def generations(
             response_format: Optional[str] | NotGiven = NOT_GIVEN,
             size: Optional[str] | NotGiven = NOT_GIVEN,
             style: Optional[str] | NotGiven = NOT_GIVEN,
+            sensitive_word_check: Optional[SensitiveWordCheckRequest] | NotGiven = NOT_GIVEN,
             user: str | NotGiven = NOT_GIVEN,
             request_id: Optional[str] | NotGiven = NOT_GIVEN,
             user_id: Optional[str] | NotGiven = NOT_GIVEN,
@@ -46,6 +48,7 @@ def generations(
                 "n": n,
                 "quality": quality,
                 "response_format": response_format,
+                "sensitive_word_check": sensitive_word_check,
                 "size": size,
                 "style": style,
                 "user": user,

zhipuai/api_resource/videos/videos.py

@@ -4,6 +4,7 @@
 from typing import TYPE_CHECKING, List, Mapping, cast, Optional, Dict
 from typing_extensions import Literal
 
+from ...types.sensitive_word_check import SensitiveWordCheckRequest
 from ...types.video import video_create_params
 from ...types.video import VideoObject
 from ...core import BaseAPI, maybe_transform
@@ -33,6 +34,7 @@ def generations(
             *,
             prompt: str = None,
             image_url: str = None,
+            sensitive_word_check: Optional[SensitiveWordCheckRequest] | NotGiven = NOT_GIVEN,
             request_id: str = None,
             user_id: str = None,
             extra_headers: Headers | None = None,
@@ -47,6 +49,7 @@ def generations(
                 "model": model,
                 "prompt": prompt,
                 "image_url": image_url,
+                "sensitive_word_check": sensitive_word_check,
                 "request_id": request_id,
                 "user_id": user_id,
             }

zhipuai/types/sensitive_word_check/__init__.py

@@ -0,0 +1,8 @@
+
+
+from .sensitive_word_check import SensitiveWordCheckRequest
+
+
+__all__ = [
+    "SensitiveWordCheckRequest"
+]

zhipuai/types/sensitive_word_check/sensitive_word_check.py

@@ -0,0 +1,14 @@
+from typing import Optional
+
+from typing_extensions import TypedDict
+
+
+class SensitiveWordCheckRequest(TypedDict, total=False):
+    type: Optional[str]
+    """敏感词类型，当前仅支持ALL"""
+    status: Optional[str]
+    """敏感词启用禁用状态
+        启用：ENABLE
+        禁用：DISABLE
+       备注：默认开启敏感词校验，如果要关闭敏感词校验，需联系商务获取对应权限，否则敏感词禁用不生效。
+    """

zhipuai/types/video/video_create_params.py

@@ -6,13 +6,17 @@
 
 __all__ = ["VideoCreateParams"]
 
+from ..sensitive_word_check import SensitiveWordCheckRequest
+
 
 class VideoCreateParams(TypedDict, total=False):
     model: str
     """模型编码"""
     prompt: str
     """所需视频的文本描述"""
     image_url: str
+    """所需视频的文本描述"""
+    sensitive_word_check: Optional[SensitiveWordCheckRequest]
     """支持 URL 或者 Base64、传入 image 奖进行图生视频
      * 图片格式：
      *   图片大小："""