Add xai-sdk-version to the request metadata (#41)

# Add xai-sdk-version to the request metadata

## Checklist
- [x] I have read both the [CONTRIBUTING.md](CONTRIBUTING.md) and
[Contributor License Agreement](CLA.md) documents.
- [x] I have created an issue or feature request and received approval
from xAI maintainers. (minor changes like fixing typos can skip this
step)
- [x] I have tested my changes locally and they pass all CI checks.
- [x] I have added necessary documentation or updated existing
documentation.

## Description
Add `xai-sdk-version` as a new metadata into the request header.

Tested locally, the sdk-version can be successfully read from the server
side.

## Related Issue
If applicable, link to the related feature request or bug report issue
(e.g., #123). If none, state "N/A".

## Type of Change
- [ ] Bug fix
- [x] New feature
- [ ] Documentation update
- [ ] Other (please specify)

## Additional Notes
Add any other information or context that might be helpful for
reviewers.

Author: mark-xai

src/xai_sdk/aio/client.py

@@ -23,7 +23,7 @@ def _init(
         management_api_key: Optional[str],
         api_host: str,
         management_api_host: str,
-        metadata: Optional[tuple[tuple[str, str]]],
+        metadata: Optional[tuple[tuple[str, str], ...]],
         channel_options: Sequence[tuple[str, Any]],
         timeout: float,
     ) -> None:
@@ -55,7 +55,7 @@ def _make_grpc_channel(
         self,
         api_key: str,
         api_host: str,
-        metadata: Optional[tuple[tuple[str, str]]],
+        metadata: Optional[tuple[tuple[str, str], ...]],
         channel_options: Sequence[tuple[str, Any]],
         timeout: float,
     ) -> grpc.aio.Channel:

src/xai_sdk/client.py

@@ -6,6 +6,8 @@
 
 import grpc
 
+from .__about__ import __version__
+
 # Retries if the service returns an UNAVAILABLE error.
 _DEFAULT_SERVICE_CONFIG_JSON = json.dumps(
     {
@@ -57,7 +59,7 @@ def __init__(
         *,
         api_host: str = "api.x.ai",
         management_api_host: str = "management-api.x.ai",
-        metadata: Optional[tuple[tuple[str, str]]] = None,
+        metadata: Optional[tuple[tuple[str, str], ...]] = None,
         channel_options: Optional[list[tuple[str, Any]]] = None,
         timeout: Optional[float] = None,
     ) -> None:
@@ -86,6 +88,9 @@ def __init__(
         default_options = [option for option in _DEFAULT_CHANNEL_OPTIONS if option[0] not in user_defined_options]
         timeout = timeout or _DEFAULT_RPC_TIMEOUT_SECONDS
 
+        # Add the xAI SDK version to the metadata
+        metadata = (metadata or ()) + (("xai-sdk-version", __version__),)
+
         self._init(
             api_key,
             management_api_key,
@@ -103,15 +108,15 @@ def _init(
         management_api_key: Optional[str],
         api_host: str,
         management_api_host: str,
-        metadata: Optional[tuple[tuple[str, str]]],
+        metadata: Optional[tuple[tuple[str, str], ...]],
         channel_options: Sequence[tuple[str, Any]],
         timeout: float,
     ) -> None:
         """Initializes the client instance."""
 
 
 def create_channel_credentials(
-    api_key: str, api_host: str, metadata: Optional[tuple[tuple[str, str]]]
+    api_key: str, api_host: str, metadata: Optional[tuple[tuple[str, str], ...]]
 ) -> grpc.ChannelCredentials:
     """Creates the credentials for the gRPC channel.
 
@@ -138,7 +143,7 @@ def create_channel_credentials(
 class _APIAuthPlugin(grpc.AuthMetadataPlugin):
     """A specification for API-key based authentication."""
 
-    def __init__(self, api_key: str, metadata: Optional[tuple[tuple[str, str]]]) -> None:
+    def __init__(self, api_key: str, metadata: Optional[tuple[tuple[str, str], ...]]) -> None:
         """Initializes a new instance of the `_APIAuthPlugin` class.
 
         Args:

src/xai_sdk/sync/client.py

@@ -23,7 +23,7 @@ def _init(
         management_api_key: Optional[str],
         api_host: str,
         management_api_host: str,
-        metadata: Optional[tuple[tuple[str, str]]],
+        metadata: Optional[tuple[tuple[str, str], ...]],
         channel_options: Sequence[tuple[str, Any]],
         timeout: float,
     ) -> None:
@@ -54,7 +54,7 @@ def _make_grpc_channel(
         self,
         api_key: str,
         api_host: str,
-        metadata: Optional[tuple[tuple[str, str]]],
+        metadata: Optional[tuple[tuple[str, str], ...]],
         channel_options: Sequence[tuple[str, Any]],
         timeout: float,
     ) -> grpc.Channel: