Merge pull request #216 from ollama/royh/embed-docs

Deprecate embeddings from docs in favor of embed
This commit is contained in:
Patrick Devine
2024-09-12 17:14:07 -07:00
committed by GitHub
2 changed files with 14 additions and 2 deletions

View File

@@ -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

View File

@@ -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',