OllamaEndpoint

Namespace: Wisej.AI.Endpoints

Assembly: Wisej.AI

• SmartEndpoint
  • SmartHttpEndpoint
    • OllamaEndpoint

Represents an endpoint that connects to Ollama services, providing functionalities for chat and embeddings.

C#

public class OllamaEndpoint : SmartHttpEndpoint

VB.NET

Public Class OllamaEndpoint
    Inherits SmartHttpEndpoint

This class extends the SmartHttpEndpoint to interact with Ollama endpoints. It provides methods to construct API URLs, add options to messages, and handle responses.

Constructors

OllamaEndpoint()

Initializes a new instance of the OllamaEndpoint class with default settings.

Properties

EmbeddingModel

String: Gets or sets the embedding model used by the endpoint. (Default: "all-minilm")

MaxContextTokens

Int32: Gets or sets the maximum number of tokens the context window for the specified Model can hold. (Default: 8192)

Methods

AddOptions(message, session)

Adds options to the message for the current session.

Parameter	Type	Description
message	Object	The dynamic message object to which options are added.
session	SmartSession	The current session containing model options.

Throws:

• ArgumentNullException Thrown when the message is null.

AskEmbeddingsAsync(inputs)

Asynchronously requests embeddings for the specified inputs.

Parameter	Type	Description
inputs	String[]	An array of input strings for which embeddings are requested.

Returns: Task<Embedding>. A task representing the asynchronous operation, with a result of type Embedding.

Throws:

• ArgumentNullException Thrown when the inputs are null.

BuildEmbeddingsPayload(inputs)

Builds the payload for the embeddings request.

Parameter	Type	Description
inputs	String[]	An array of input strings for which the payload is built.

Returns: Object. An object representing the payload for the embeddings request.

Throws:

• ArgumentNullException Thrown when the inputs are null.

GetApiURL()

Constructs the API URL for chat interactions.

Returns: String. A string representing the chat API URL.

GetEmbeddingsURL()

Constructs the API URL for embeddings interactions.

Returns: String. A string representing the embeddings API URL.

ReadAssistantMessage(response, message)

Reads the assistant's message from the response and updates the message object.

Parameter	Type	Description
response	Response	The response received from the API.
message	Message	The message object to be updated with the assistant's response.

Throws:

• ArgumentNullException Thrown when the response or message is null.

ReadEmbeddingsResponse(response)

Reads the embeddings response and extracts the embeddings data.

Parameter	Type	Description
response	Response	The response received from the API.

Returns: Single[][]. A jagged array of floats representing the embeddings.

Throws:

• ArgumentNullException Thrown when the response is null.

ReadUsage(message, reply)

Reads the usage statistics from the reply and updates the message usage.

Parameter	Type	Description
message	Message	The message object to be updated with usage statistics.
reply	Object	The dynamic reply object containing usage information.