Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 20, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/xai_sdk/aio/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
13 changes: 9 additions & 4 deletions src/xai_sdk/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

import grpc

from .__about__ import __version__

# Retries if the service returns an UNAVAILABLE error.
_DEFAULT_SERVICE_CONFIG_JSON = json.dumps(
{
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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,
Expand All @@ -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.

Expand All @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions src/xai_sdk/sync/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down