feat: support api key

Author: hexiaochun

volcenginesdkarkruntime/_client.py

@@ -38,6 +38,7 @@ def __init__(
         base_url: str | URL = BASE_URL,
         ak: str | None = None,
         sk: str | None = None,
+        api_key: str | None = None,
         timeout: float | Timeout | None = DEFAULT_TIMEOUT,
         max_retries: int = DEFAULT_MAX_RETRIES,
         http_client: Client | None = None,
@@ -48,6 +49,7 @@ def __init__(
             Args:
                 ak: access key id
                 sk: secret access key
+                api_key: api key，this api key will not be refreshed
                 timeout: timeout of client. default httpx.Timeout(timeout=60.0, connect=60.0)
                 max_retries: times of retry when request failed. default 1
                 http_client: specify customized http_client
@@ -59,8 +61,13 @@ def __init__(
             ak = os.environ.get("VOLC_ACCESSKEY")
         if sk is None:
             sk = os.environ.get("VOLC_SECRETKEY")
+        if api_key is None:
+            api_key = os.environ.get("ARK_API_KEY")
         self.ak = ak
         self.sk = sk
+        self.api_key = api_key
+
+        assert (api_key is not None) or (ak is not None and sk is not None), "you need to support api_key or ak&sk"
 
         super().__init__(
             base_url=base_url,
@@ -82,6 +89,11 @@ def _get_endpoint_sts_token(self, endpoint_id: str):
             self._sts_token_manager = StsTokenManager(self.ak, self.sk)
         return self._sts_token_manager.get(endpoint_id)
 
+    @property
+    def auth_headers(self) -> dict[str, str]:
+        api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
+
 
 class AsyncArk(AsyncAPIClient):
     chat: resources.AsyncChat
@@ -91,6 +103,7 @@ def __init__(
         *,
         ak: str | None = None,
         sk: str | None = None,
+        api_key: str | None = None,
         base_url: str | URL = BASE_URL,
         timeout: float | Timeout | None = DEFAULT_TIMEOUT,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -101,6 +114,7 @@ def __init__(
             Args:
                 ak: access key id
                 sk: secret access key
+                api_key: api key，this api key will not be refreshed
                 timeout: timeout of client. default httpx.Timeout(timeout=60.0, connect=60.0)
                 max_retries: times of retry when request failed. default 1
                 http_client: specify customized http_client
@@ -112,8 +126,13 @@ def __init__(
             ak = os.environ.get("VOLC_ACCESSKEY")
         if sk is None:
             sk = os.environ.get("VOLC_SECRETKEY")
+        if api_key is None:
+            api_key = os.environ.get("ARK_API_KEY")
         self.ak = ak
         self.sk = sk
+        self.api_key = api_key
+
+        assert (api_key is not None) or (ak is not None and sk is not None), "you need to support api_key or ak&sk"
 
         super().__init__(
             base_url=base_url,
@@ -135,6 +154,11 @@ def _get_endpoint_sts_token(self, endpoint_id: str):
             self._sts_token_manager = StsTokenManager(self.ak, self.sk)
         return self._sts_token_manager.get(endpoint_id)
 
+    @property
+    def auth_headers(self) -> dict[str, str]:
+        api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
+
 
 class StsTokenManager(object):
 

volcenginesdkarkruntime/_utils/_utils.py

@@ -80,6 +80,6 @@ def _insert_sts_token(args, kwargs):
 
     ark_client = args[0]._client
     model = kwargs.get("model", "")
-    if model and model.startswith("ep-") and ark_client.ak and ark_client.sk:
+    if ark_client.api_key is None and model and model.startswith("ep-") and ark_client.ak and ark_client.sk:
         default_auth_header = {"Authorization": "Bearer " + ark_client._get_endpoint_sts_token(model)}
         kwargs["extra_headers"] = {**default_auth_header, **kwargs.get("extra_headers", {})}

volcenginesdkexamples/volcenginesdkarkruntime/example_async_chat_completions.py

@@ -2,9 +2,15 @@
 
 from volcenginesdkarkruntime import AsyncArk
 
-# fetch ak&sk from environmental variables "VOLC_ACCESSKEY", "VOLC_SECRETKEY"
+# Support ak&sk or api key
+# 1. Fetch ak&sk from environmental variables "VOLC_ACCESSKEY", "VOLC_SECRETKEY"
 # or specify ak&sk by Ark(ak="${YOUR_AK}", sk="${YOUR_SK}").
 # you can get ak&sk follow this document(https://www.volcengine.com/docs/6291/65568)
+#
+# 2. Fetch api key from environmental variables "ARK_API_KEY"
+# or specify api key by Ark(api_key="${YOUR_API_KEY}").
+# Note: if you support api key，this api key will not be refreshed.
+# If you don't want the api to fail after a period of time, to the api key that never expires.
 client = AsyncArk()
 
 

volcenginesdkexamples/volcenginesdkarkruntime/example_chat_completions.py

@@ -1,8 +1,14 @@
 from volcenginesdkarkruntime import Ark
 
-# fetch ak&sk from environmental variables "VOLC_ACCESSKEY", "VOLC_SECRETKEY"
+# Support ak&sk or api key
+# 1. Fetch ak&sk from environmental variables "VOLC_ACCESSKEY", "VOLC_SECRETKEY"
 # or specify ak&sk by Ark(ak="${YOUR_AK}", sk="${YOUR_SK}").
 # you can get ak&sk follow this document(https://www.volcengine.com/docs/6291/65568)
+#
+# 2. Fetch api key from environmental variables "ARK_API_KEY"
+# or specify api key by Ark(api_key="${YOUR_API_KEY}").
+# Note: if you support api key，this api key will not be refreshed.
+# If you don't want the api to fail after a period of time, to the api key that never expires.
 client = Ark()
 
 if __name__ == "__main__":
@@ -19,6 +25,26 @@
     )
     print(completion.choices[0].message.content)
 
+    print("----- multiple rounds request -----")
+    completion = client.chat.completions.create(
+        model="${YOUR_ENDPOINT_ID}",
+        messages=[
+            {
+                "role": "user",
+                "content": "Say this is a test",
+            },
+            {
+                "role": "assistant",
+                "content": "this is a test",
+            },
+            {
+                "role": "user",
+                "content": "what have you say?",
+            },
+        ]
+    )
+    print(completion.choices[0].message.content)
+
     # Streaming:
     print("----- streaming request -----")
     stream = client.chat.completions.create(