Merge pull request #1091 from weaviate/20240603/update-ollama-docstring

Update Ollama module docstrings
weaviate · Jun 3, 2024 · fac3663 · fac3663
2 parents dc2feaf + 83a1250
commit fac3663
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/weaviate/collections/classes/config.py b/weaviate/collections/classes/config.py
@@ -536,6 +536,16 @@ def ollama(
         api_endpoint: Optional[str] = None,
         model: Optional[str] = None,
     ) -> _GenerativeConfigCreate:
+        """
+        Create a `_GenerativeOllama` object for use when performing AI generation using the `generative-ollama` module.
+
+        Arguments:
+            `api_endpoint`
+                The API endpoint to use. Defaults to `None`, which uses the server-defined default
+                Docker users may need to specify an alias, such as `http://host.docker.internal:11434` so that the container can access the host machine.
+            `model`
+                The model to use. Defaults to `None`, which uses the server-defined default
+        """
         return _GenerativeOllama(model=model, apiEndpoint=api_endpoint)
 
     @staticmethod

diff --git a/weaviate/collections/classes/config_named_vectors.py b/weaviate/collections/classes/config_named_vectors.py
@@ -263,6 +263,7 @@ def text2vec_ollama(
                 Whether to vectorize the collection name. Defaults to `True`.
             `api_endpoint`
                 The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
+                Docker users may need to specify an alias, such as `http://host.docker.internal:11434` so that the container can access the host machine.
 
         """
         return _NamedVectorConfigCreate(

diff --git a/weaviate/collections/classes/config_vectorizers.py b/weaviate/collections/classes/config_vectorizers.py
@@ -777,6 +777,7 @@ def text2vec_ollama(
         Arguments:
             `api_endpoint`
                 The base URL to use where API requests should go. Defaults to `None`, which uses the server-defined default.
+                Docker users may need to specify an alias, such as `http://host.docker.internal:11434` so that the container can access the host machine.
             `modelId`
                 The model to use. Defaults to `None`, which uses the server-defined default.
             `vectorize_collection_name`