Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 18 additions & 8 deletions docs-website/reference/integrations-api/ollama.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ slug: "/integrations-ollama"

### OllamaDocumentEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of each
Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand Down Expand Up @@ -41,9 +42,11 @@ __init__(
meta_fields_to_embed: list[str] | None = None,
embedding_separator: str = "\n",
batch_size: int = 32,
)
) -> None
```

Create a new OllamaDocumentEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -116,8 +119,9 @@ Asynchronously run an Ollama Model to compute embeddings of the provided documen

### OllamaTextEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of
each Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand All @@ -138,9 +142,11 @@ __init__(
generation_kwargs: dict[str, Any] | None = None,
timeout: int = 120,
keep_alive: float | str | None = None,
)
) -> None
```

Create a new OllamaTextEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -236,9 +242,11 @@ __init__(
tools: ToolsType | None = None,
response_format: None | Literal["json"] | JsonSchemaValue | None = None,
think: bool | Literal["low", "medium", "high"] = False,
)
) -> None
```

Create a new OllamaChatGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model must already be present (pulled) in the running Ollama instance.
Expand Down Expand Up @@ -395,9 +403,11 @@ __init__(
timeout: int = 120,
keep_alive: float | str | None = None,
streaming_callback: Callable[[StreamingChunk], None] | None = None,
)
) -> None
```

Create a new OllamaGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ slug: "/integrations-ollama"

### OllamaDocumentEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of each
Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand Down Expand Up @@ -41,9 +42,11 @@ __init__(
meta_fields_to_embed: list[str] | None = None,
embedding_separator: str = "\n",
batch_size: int = 32,
)
) -> None
```

Create a new OllamaDocumentEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -116,8 +119,9 @@ Asynchronously run an Ollama Model to compute embeddings of the provided documen

### OllamaTextEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of
each Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand All @@ -138,9 +142,11 @@ __init__(
generation_kwargs: dict[str, Any] | None = None,
timeout: int = 120,
keep_alive: float | str | None = None,
)
) -> None
```

Create a new OllamaTextEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -236,9 +242,11 @@ __init__(
tools: ToolsType | None = None,
response_format: None | Literal["json"] | JsonSchemaValue | None = None,
think: bool | Literal["low", "medium", "high"] = False,
)
) -> None
```

Create a new OllamaChatGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model must already be present (pulled) in the running Ollama instance.
Expand Down Expand Up @@ -395,9 +403,11 @@ __init__(
timeout: int = 120,
keep_alive: float | str | None = None,
streaming_callback: Callable[[StreamingChunk], None] | None = None,
)
) -> None
```

Create a new OllamaGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ slug: "/integrations-ollama"

### OllamaDocumentEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of each
Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand Down Expand Up @@ -41,9 +42,11 @@ __init__(
meta_fields_to_embed: list[str] | None = None,
embedding_separator: str = "\n",
batch_size: int = 32,
)
) -> None
```

Create a new OllamaDocumentEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -116,8 +119,9 @@ Asynchronously run an Ollama Model to compute embeddings of the provided documen

### OllamaTextEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of
each Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand All @@ -138,9 +142,11 @@ __init__(
generation_kwargs: dict[str, Any] | None = None,
timeout: int = 120,
keep_alive: float | str | None = None,
)
) -> None
```

Create a new OllamaTextEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -236,9 +242,11 @@ __init__(
tools: ToolsType | None = None,
response_format: None | Literal["json"] | JsonSchemaValue | None = None,
think: bool | Literal["low", "medium", "high"] = False,
)
) -> None
```

Create a new OllamaChatGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model must already be present (pulled) in the running Ollama instance.
Expand Down Expand Up @@ -395,9 +403,11 @@ __init__(
timeout: int = 120,
keep_alive: float | str | None = None,
streaming_callback: Callable[[StreamingChunk], None] | None = None,
)
) -> None
```

Create a new OllamaGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ slug: "/integrations-ollama"

### OllamaDocumentEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of each
Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand Down Expand Up @@ -41,9 +42,11 @@ __init__(
meta_fields_to_embed: list[str] | None = None,
embedding_separator: str = "\n",
batch_size: int = 32,
)
) -> None
```

Create a new OllamaDocumentEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -116,8 +119,9 @@ Asynchronously run an Ollama Model to compute embeddings of the provided documen

### OllamaTextEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of
each Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand All @@ -138,9 +142,11 @@ __init__(
generation_kwargs: dict[str, Any] | None = None,
timeout: int = 120,
keep_alive: float | str | None = None,
)
) -> None
```

Create a new OllamaTextEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -236,9 +242,11 @@ __init__(
tools: ToolsType | None = None,
response_format: None | Literal["json"] | JsonSchemaValue | None = None,
think: bool | Literal["low", "medium", "high"] = False,
)
) -> None
```

Create a new OllamaChatGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model must already be present (pulled) in the running Ollama instance.
Expand Down Expand Up @@ -395,9 +403,11 @@ __init__(
timeout: int = 120,
keep_alive: float | str | None = None,
streaming_callback: Callable[[StreamingChunk], None] | None = None,
)
) -> None
```

Create a new OllamaGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ slug: "/integrations-ollama"

### OllamaDocumentEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of each
Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand Down Expand Up @@ -41,9 +42,11 @@ __init__(
meta_fields_to_embed: list[str] | None = None,
embedding_separator: str = "\n",
batch_size: int = 32,
)
) -> None
```

Create a new OllamaDocumentEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -116,8 +119,9 @@ Asynchronously run an Ollama Model to compute embeddings of the provided documen

### OllamaTextEmbedder

Computes the embeddings of a list of Documents and stores the obtained vectors in the embedding field of
each Document. It uses embedding models compatible with the Ollama Library.
Computes the embeddings of a list of Documents and stores the obtained vectors in each Document's embedding field.

It uses embedding models compatible with the Ollama Library.

Usage example:

Expand All @@ -138,9 +142,11 @@ __init__(
generation_kwargs: dict[str, Any] | None = None,
timeout: int = 120,
keep_alive: float | str | None = None,
)
) -> None
```

Create a new OllamaTextEmbedder instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down Expand Up @@ -236,9 +242,11 @@ __init__(
tools: ToolsType | None = None,
response_format: None | Literal["json"] | JsonSchemaValue | None = None,
think: bool | Literal["low", "medium", "high"] = False,
)
) -> None
```

Create a new OllamaChatGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model must already be present (pulled) in the running Ollama instance.
Expand Down Expand Up @@ -395,9 +403,11 @@ __init__(
timeout: int = 120,
keep_alive: float | str | None = None,
streaming_callback: Callable[[StreamingChunk], None] | None = None,
)
) -> None
```

Create a new OllamaGenerator instance.

**Parameters:**

- **model** (<code>str</code>) – The name of the model to use. The model should be available in the running Ollama instance.
Expand Down
Loading
Loading