diff --git a/litellm/constants.py b/litellm/constants.py index 8cc51d0ab5e..0a99972feab 100644 --- a/litellm/constants.py +++ b/litellm/constants.py @@ -1666,6 +1666,7 @@ BILLED_RETRY_ATTEMPT_METADATA_KEY: Final = "billed_retry_attempt" MANAGED_BACKGROUND_RESPONSE_METADATA_KEY: Final = "_managed_background_response" SESSION_ID_GENERATED_METADATA_KEY: Final = "litellm_session_id_generated" SESSION_ID_OMITTED_METADATA_KEY: Final = "litellm_session_id_omitted" +SESSION_ID_FROM_TRACE_ID_PARAM_KEY: Final = "litellm_session_id_from_trace_id" CALLER_SESSION_ID_METADATA_KEY: Final = "litellm_caller_session_id" LITELLM_TRUNCATED_PAYLOAD_FIELD: Final = "litellm_truncated" LITELLM_TRUNCATION_DB_SAFEGUARD_NOTE: Final = ( diff --git a/litellm/litellm_core_utils/get_litellm_params.py b/litellm/litellm_core_utils/get_litellm_params.py index ca8e2af18e6..ba964d200ec 100644 --- a/litellm/litellm_core_utils/get_litellm_params.py +++ b/litellm/litellm_core_utils/get_litellm_params.py @@ -6,7 +6,7 @@ from typing import Final, cast from pydantic import TypeAdapter, ValidationError -from litellm.constants import CONTROL_OPTIONS_KEY +from litellm.constants import CONTROL_OPTIONS_KEY, SESSION_ID_FROM_TRACE_ID_PARAM_KEY from litellm.litellm_core_utils.core_helpers import normalize_drop_params from litellm.llms.openai.data_residency import infer_openai_data_residency from litellm.types.litellm_params import MAX_CONTROL_INT_DIGITS, ControlOptions @@ -212,6 +212,9 @@ def get_litellm_params( # Derive litellm_session_id / litellm_trace_id from metadata when not provided (call chaining) _meta: Final = resolved_metadata or {} + session_id_from_trace_id: Final = ( + litellm_session_id is None and not _meta.get("session_id") and bool(_meta.get("trace_id")) + ) if litellm_session_id is None: litellm_session_id = _meta.get("session_id") or _meta.get("trace_id") if litellm_trace_id is None: @@ -254,6 +257,7 @@ def get_litellm_params( or (get_base_model_from_litellm_call_metadata(metadata=metadata) if metadata else None), "litellm_trace_id": litellm_trace_id, "litellm_session_id": litellm_session_id, + **({SESSION_ID_FROM_TRACE_ID_PARAM_KEY: True} if session_id_from_trace_id else {}), "hf_model_name": hf_model_name, "custom_prompt_dict": custom_prompt_dict, "litellm_metadata": litellm_metadata, diff --git a/litellm/litellm_core_utils/provider_affinity.py b/litellm/litellm_core_utils/provider_affinity.py index de6eb333ba1..c831e92c09d 100644 --- a/litellm/litellm_core_utils/provider_affinity.py +++ b/litellm/litellm_core_utils/provider_affinity.py @@ -2,7 +2,7 @@ import re from collections.abc import Mapping from typing import Final -from litellm.constants import SESSION_ID_GENERATED_METADATA_KEY +from litellm.constants import SESSION_ID_FROM_TRACE_ID_PARAM_KEY, SESSION_ID_GENERATED_METADATA_KEY _HTTP_HEADER_NAME_PATTERN: Final = re.compile(r"^[!#$%&'*+\-.^_`|~0-9A-Za-z]+$") _FORBIDDEN_AFFINITY_HEADERS: Final = frozenset( @@ -61,8 +61,7 @@ def _metadata_values(litellm_params: object) -> tuple[object, ...]: def _non_generated_litellm_session_id(litellm_params: object) -> str | None: has_generated_session_id: Final = any( - isinstance(metadata, Mapping) and metadata.get(SESSION_ID_GENERATED_METADATA_KEY) - for metadata in _metadata_values(litellm_params) + _get_value(metadata, SESSION_ID_GENERATED_METADATA_KEY) for metadata in _metadata_values(litellm_params) ) litellm_session_id: Final = _get_value(litellm_params, "litellm_session_id") return str(litellm_session_id) if litellm_session_id and not has_generated_session_id else None @@ -70,28 +69,17 @@ def _non_generated_litellm_session_id(litellm_params: object) -> str | None: def _metadata_session_id(litellm_params: object) -> str | None: for metadata in _metadata_values(litellm_params): - if ( - isinstance(metadata, Mapping) - and not metadata.get(SESSION_ID_GENERATED_METADATA_KEY) - and (value := metadata.get("session_id")) + if not _get_value(metadata, SESSION_ID_GENERATED_METADATA_KEY) and ( + value := _get_value(metadata, "session_id") ): return str(value) return None -def _metadata_field_equals(litellm_params: object, field: str, value: str) -> bool: - return any(_get_value(metadata, field) == value for metadata in _metadata_values(litellm_params)) - - def get_caller_litellm_session_id(litellm_params: object | None) -> str | None: - if litellm_params is None: + if litellm_params is None or _get_value(litellm_params, SESSION_ID_FROM_TRACE_ID_PARAM_KEY): return None - session_id: Final = _non_generated_litellm_session_id(litellm_params) - copies_trace_id: Final = session_id is not None and ( - _metadata_field_equals(litellm_params, "trace_id", session_id) - and not _metadata_field_equals(litellm_params, "session_id", session_id) - ) - return None if copies_trace_id else session_id + return _non_generated_litellm_session_id(litellm_params) def get_requested_session_id(litellm_params: object | None) -> str | None: diff --git a/tests/unit/llms/chatgpt/test_chatgpt_common_utils.py b/tests/unit/llms/chatgpt/test_chatgpt_common_utils.py index 79bfbc4da1a..375c140187e 100644 --- a/tests/unit/llms/chatgpt/test_chatgpt_common_utils.py +++ b/tests/unit/llms/chatgpt/test_chatgpt_common_utils.py @@ -103,6 +103,7 @@ class TestGetChatGPTSessionId: {"litellm_session_id": "chosen"}, {"session_id": "chosen"}, {"metadata": {"session_id": "chosen"}}, + get_litellm_params(litellm_session_id="chosen", metadata={"trace_id": "chosen"}), ], ) def test_explicit_session_id_wins_over_prompt_cache_key(self, explicit: Mapping[str, object]) -> None: @@ -114,7 +115,7 @@ class TestGetChatGPTSessionId: {"litellm_trace_id": "trace-1"}, {"litellm_call_id": "call-1"}, get_litellm_params(metadata={"trace_id": "trace-1"}), - {"litellm_session_id": "trace-1", "litellm_metadata": {"trace_id": "trace-1"}}, + get_litellm_params(litellm_metadata={"trace_id": "trace-1"}), {"litellm_session_id": "gen-1", "metadata": {"session_id": "gen-1", SESSION_ID_GENERATED_METADATA_KEY: True}}, { "litellm_session_id": "gen-1", @@ -125,16 +126,19 @@ class TestGetChatGPTSessionId: def test_prompt_cache_key_wins_over_request_scoped_ids(self, request_scoped: Mapping[str, object]) -> None: assert get_chatgpt_session_id({**request_scoped, "prompt_cache_key": "conv-123"}) == "conv-123" - def test_proxy_mapped_session_header_wins_over_body_session_id(self) -> None: + @pytest.mark.parametrize( + "mapped_header", + [ + { + "litellm_session_id": "header-session", + "metadata": {"trace_id": "header-session", "session_id": "header-session"}, + }, + get_litellm_params(metadata={"trace_id": "header-session", "session_id": "header-session"}), + ], + ) + def test_proxy_mapped_session_header_wins_over_body_session_id(self, mapped_header: Mapping[str, object]) -> None: assert ( - get_chatgpt_session_id( - { - "litellm_session_id": "header-session", - "metadata": {"trace_id": "header-session", "session_id": "header-session"}, - "session_id": "body-session", - "prompt_cache_key": "conv-123", - } - ) + get_chatgpt_session_id({**mapped_header, "session_id": "body-session", "prompt_cache_key": "conv-123"}) == "header-session" )