Skip to content

Commit

Permalink
Update Ollama module docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
databyjp committed Jun 3, 2024
1 parent dc2feaf commit 83a1250
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
10 changes: 10 additions & 0 deletions weaviate/collections/classes/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions weaviate/collections/classes/config_named_vectors.py
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
1 change: 1 addition & 0 deletions weaviate/collections/classes/config_vectorizers.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 83a1250

Please sign in to comment.