From 83a12504958c089684eb161a4c539a3aedd9c73d Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Mon, 3 Jun 2024 16:49:29 +0100 Subject: [PATCH] Update Ollama module docstrings --- weaviate/collections/classes/config.py | 10 ++++++++++ weaviate/collections/classes/config_named_vectors.py | 1 + weaviate/collections/classes/config_vectorizers.py | 1 + 3 files changed, 12 insertions(+) diff --git a/weaviate/collections/classes/config.py b/weaviate/collections/classes/config.py index 08528fb64..34e5ea4bc 100644 --- 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 index 81c64bfc9..3db7dbe86 100644 --- 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 index 32ad3f4a8..e9ec6ff4e 100644 --- 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`