docstring update - key-pair info

deepset-ai · Nov 19, 2024 · 0492dc4 · 0492dc4
1 parent 3f7a045
commit 0492dc4
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/...ke/src/haystack_integrations/components/retrievers/snowflake/snowflake_table_retriever.py b/...ke/src/haystack_integrations/components/retrievers/snowflake/snowflake_table_retriever.py
@@ -84,8 +84,10 @@ def __init__(
         :param db_schema: Name of the schema to use.
         :param warehouse: Name of the warehouse to use.
         :param login_timeout: Timeout in seconds for login. By default, 60 seconds.
-        :param private_key_file: Location of private key
-            mutually exclusive to password, if key_file is provided this auth method will be used.
+        :param private_key_file: Location of private key-pair file.
+            This is mutually exclusive to password, if key_file is provided this auth method will be used.
+            See Snowflake documentation on Key-Pair authentication for further information:
+              https://docs.snowflake.com/en/user-guide/key-pair-auth
         :param private_key_file_pwd: Password for private key file
         """