Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Ollama module docstrings #1091

Merged
merged 1 commit into from
Jun 3, 2024
Merged

Update Ollama module docstrings #1091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions weaviate/collections/classes/config.py
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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