mark embeddings() method as deprecated in favor of embed()

README.md

@@ -174,18 +174,19 @@ ollama.show(request)
   - `options` `<Options>`: (Optional) Options to configure the runtime.
 - Returns: `<ShowResponse>`
 
-### embeddings
+### embed
 
 ```javascript
-ollama.embeddings(request)
+ollama.embed(request)
 ```
 
 - `request` `<Object>`: The request object containing embedding parameters.
   - `model` `<string>` The name of the model used to generate the embeddings.
-  - `prompt` `<string>`: The prompt used to generate the embedding.
+  - `input` `<string> | <string[]>`: The input used to generate the embedding.
+  - `truncate` `<boolean>`: (Optional) Truncate the input to fit the maximum context length supported by the model.
   - `keep_alive` `<string | number>`: (Optional) How long to keep the model loaded.
   - `options` `<Options>`: (Optional) Options to configure the runtime.
-- Returns: `<EmbeddingsResponse>`
+- Returns: `<EmbedResponse>`
 
 ### ps
 

src/browser.ts

@@ -66,7 +66,7 @@
    */
   protected async processStreamableRequest<T extends object>(
     endpoint: string,
     request: { stream?: boolean } & Record<string, any>,
   ): Promise<T | AbortableAsyncIterator<T>> {
     request.stream = request.stream ?? false
     const host = `${this.config.host}/api/${endpoint}`
@@ -286,6 +286,7 @@
 
   /**
    * Embeds a text prompt into a vector.
+   * @deprecated Use the `embed` method instead.
    * @param request {EmbeddingsRequest} - The request object.
    * @returns {Promise<EmbeddingsResponse>} - The response object.
    */

src/interfaces.ts

@@ -119,6 +119,9 @@
   options?: Partial<Options>
 }
 
+/**
+ * @deprecated Use the EmbedRequest interface with the embed() method instead.
+ */
 export interface EmbeddingsRequest {
   model: string
   prompt: string
@@ -163,6 +166,9 @@
   embeddings: number[][]
 }
 
+/**
+ * @deprecated Use the embed() method with the EmbedResponse instead.
+ */
 export interface EmbeddingsResponse {
   embedding: number[]
 }
@@ -202,8 +208,8 @@
   details: ModelDetails
   messages: Message[]
   modified_at: Date
   model_info: Map<string, any>
   projector_info?: Map<string, any>
 }
 
 export interface ListResponse {