Move get_model_name method to BaseTLM class (#100)

Author: huiwengoh

CHANGELOG.md

@@ -7,12 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.19] - 2025-07-25
+
+### Added
+
+- Add `get_model_name()` method to `TrustworthyRAG`, `TLMChatCompletion`
+
+
 ## [1.1.18] - 2025-07-25
 
 ### Fixed
 
 - Properly pass quality preset in `TLMChatCompletion`
 
+
 ## [1.1.17] - 2025-07-18
 
 ### Changed
@@ -265,7 +273,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Release of the Cleanlab TLM Python client.
 
 
-[Unreleased]: https://github.com/cleanlab/cleanlab-tlm/compare/v1.1.18...HEAD
+[Unreleased]: https://github.com/cleanlab/cleanlab-tlm/compare/v1.1.19...HEAD
+[1.1.19]: https://github.com/cleanlab/cleanlab-tlm/compare/v1.1.18...v1.1.19
 [1.1.18]: https://github.com/cleanlab/cleanlab-tlm/compare/v1.1.17...v1.1.18
 [1.1.17]: https://github.com/cleanlab/cleanlab-tlm/compare/v1.1.16...v1.1.17
 [1.1.16]: https://github.com/cleanlab/cleanlab-tlm/compare/v1.1.15...v1.1.16

src/cleanlab_tlm/__about__.py

@@ -1,2 +1,2 @@
 # SPDX-License-Identifier: MIT
-__version__ = "1.1.18"
+__version__ = "1.1.19"

src/cleanlab_tlm/internal/base.py

@@ -7,7 +7,7 @@
 import asyncio
 import os
 import sys
-from typing import TYPE_CHECKING, Optional, Union
+from typing import TYPE_CHECKING, Optional, Union, cast
 
 from cleanlab_tlm.errors import MissingApiKeyError, ValidationError
 from cleanlab_tlm.internal.concurrency import TlmRateHandler
@@ -102,3 +102,9 @@ def __init__(
         except RuntimeError:
             self._event_loop = asyncio.new_event_loop()
         self._rate_handler = TlmRateHandler()
+
+    def get_model_name(self) -> str:
+        """Returns the underlying LLM used to generate responses and score their trustworthiness.
+        Available base LLMs that you can run TLM with are listed under "model" configuration in TLMOptions.
+        """
+        return cast(str, self._options["model"])

src/cleanlab_tlm/tlm.py

@@ -531,12 +531,6 @@ async def _get_trustworthiness_score_async(
 
         return {"trustworthiness_score": response_json["confidence_score"]}
 
-    def get_model_name(self) -> str:
-        """Returns the underlying LLM used to generate responses and score their trustworthiness.
-        Available base LLMs that you can run TLM with are listed under "model" configuration in [TLMOptions](#class-tlmoptions).
-        """
-        return cast(str, self._options["model"])
-
 
 class TLMResponse(TypedDict):
     """A typed dict containing the response, trustworthiness score, and additional logs output by the Trustworthy Language Model.

tests/test_chat_completions.py

@@ -11,6 +11,7 @@
     PromptTokensDetails,
 )
 
+from cleanlab_tlm.internal.constants import _TLM_DEFAULT_MODEL
 from cleanlab_tlm.internal.types import TLMQualityPreset
 from cleanlab_tlm.tlm import TLMScore
 from cleanlab_tlm.utils.chat_completions import TLMChatCompletion
@@ -22,6 +23,14 @@
 test_response = make_text_unique(TEST_RESPONSE)
 
 
+def test_get_model_name() -> None:
+    tlm = TLMChatCompletion()
+    model_name = tlm.get_model_name()
+
+    assert model_name == tlm._options["model"]
+    assert model_name == _TLM_DEFAULT_MODEL
+
+
 @pytest.mark.parametrize(
     "quality_preset",
     ["base", "low", "medium", "high", "best"],

tests/test_config.py

@@ -2,6 +2,7 @@
 import tiktoken
 
 from cleanlab_tlm.errors import TlmBadRequestError
+from cleanlab_tlm.internal.constants import _TLM_DEFAULT_MODEL
 from cleanlab_tlm.tlm import TLM
 from cleanlab_tlm.utils.config import (
     get_default_context_limit,
@@ -14,6 +15,13 @@
 tlm_with_default_setting = TLM()
 
 
+def test_get_model_name(tlm: TLM) -> None:
+    model_name = tlm.get_model_name()
+
+    assert model_name == tlm._options["model"]
+    assert model_name == _TLM_DEFAULT_MODEL
+
+
 def test_get_default_model(tlm: TLM) -> None:
     assert tlm.get_model_name() == get_default_model()
 

tests/test_tlm_rag.py

@@ -201,6 +201,13 @@ def test_init_with_quality_preset(trustworthy_rag_api_key: str, quality_preset:
     assert tlm_rag._quality_preset == quality_preset
 
 
+def test_get_model_name(trustworthy_rag: TrustworthyRAG) -> None:
+    model_name = trustworthy_rag.get_model_name()
+
+    assert model_name == trustworthy_rag._options["model"]
+    assert model_name == _TLM_DEFAULT_MODEL
+
+
 def test_get_evals(trustworthy_rag: TrustworthyRAG) -> None:
     evals = trustworthy_rag.get_evals()