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

Deprecate embeddings from docs in favor of embed

Author: pdevine

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

ollama/_client.py

@@ -278,6 +278,9 @@ def embeddings(
     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 @@ async def embeddings(
     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',