diff --git a/README.md b/README.md index 14dfdda..e03ea00 100644 --- a/README.md +++ b/README.md @@ -101,10 +101,16 @@ ollama.pull('llama3.1') ollama.push('user/llama3.1') ``` -### Embeddings +### Embed ```python -ollama.embeddings(model='llama3.1', prompt='The sky is blue because of rayleigh scattering') +ollama.embed(model='llama3.1', input='The sky is blue because of rayleigh scattering') +``` + +### Embed (batch) + +```python +ollama.embed(model='llama3.1', input=['The sky is blue because of rayleigh scattering', 'Grass is green because of chlorophyll']) ``` ### Ps diff --git a/ollama/_client.py b/ollama/_client.py index ec9acb9..e3d9fed 100644 --- a/ollama/_client.py +++ b/ollama/_client.py @@ -278,6 +278,9 @@ class Client(BaseClient): options: Optional[Options] = None, keep_alive: Optional[Union[float, str]] = None, ) -> Mapping[str, Sequence[float]]: + """ + Deprecated in favor of `embed`. + """ return self._request( 'POST', '/api/embeddings', @@ -698,6 +701,9 @@ class AsyncClient(BaseClient): options: Optional[Options] = None, keep_alive: Optional[Union[float, str]] = None, ) -> Mapping[str, Sequence[float]]: + """ + Deprecated in favor of `embed`. + """ response = await self._request( 'POST', '/api/embeddings',