update the sentence_similarity docstring (#3374) (#3375)

tolgaakar · web-flow · commit 79a469d9789f · 2025-09-19T13:56:09.000+02:00
* update the sentence_similarity docstring

* update _async_client docstring as well
diff --git a/src/huggingface_hub/inference/_client.py b/src/huggingface_hub/inference/_client.py
@@ -1613,7 +1613,7 @@ def sentence_similarity(
                 Defaults to None.
 
         Returns:
-            `List[float]`: The embedding representing the input text.
+            `List[float]`: The similarity scores between the main sentence and the given comparison sentences.
 
         Raises:
             [`InferenceTimeoutError`]:
diff --git a/src/huggingface_hub/inference/_generated/_async_client.py b/src/huggingface_hub/inference/_generated/_async_client.py
@@ -1663,7 +1663,7 @@ async def sentence_similarity(
                 Defaults to None.
 
         Returns:
-            `List[float]`: The embedding representing the input text.
+            `List[float]`: The similarity scores between the main sentence and the given comparison sentences.
 
         Raises:
             [`InferenceTimeoutError`]:
