Ollama4j
A Java library (wrapper/binding) for Ollama server.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
io.github.ollama4j.models.chat.OllamaChatRequest Class Reference
Inheritance diagram for io.github.ollama4j.models.chat.OllamaChatRequest:
io.github.ollama4j.models.request.OllamaCommonRequest io.github.ollama4j.utils.OllamaRequestBody

Public Member Functions

 OllamaChatRequest ()
 
 OllamaChatRequest (String model, boolean think, List< OllamaChatMessage > messages)
 
boolean equals (Object o)
 
OllamaChatRequest withModel (String model)
 
OllamaChatRequest withMessage (OllamaChatMessageRole role, String content)
 
OllamaChatRequest withMessage (OllamaChatMessageRole role, String content, List< OllamaChatToolCalls > toolCalls)
 
OllamaChatRequest withMessage (OllamaChatMessageRole role, String content, List< OllamaChatToolCalls > toolCalls, List< File > images)
 
OllamaChatRequest withMessages (List< OllamaChatMessage > messages)
 
OllamaChatRequest withOptions (Options options)
 
OllamaChatRequest withGetJsonResponse ()
 
OllamaChatRequest withTemplate (String template)
 
OllamaChatRequest withStreaming ()
 
OllamaChatRequest withKeepAlive (String keepAlive)
 
OllamaChatRequest withThinking (boolean think)
 
OllamaChatRequest withUseTools (boolean useTools)
 
OllamaChatRequest withTools (List< Tools.Tool > tools)
 
OllamaChatRequest build ()
 
void reset ()
 
- Public Member Functions inherited from io.github.ollama4j.models.request.OllamaCommonRequest
String toString ()
 
- Public Member Functions inherited from io.github.ollama4j.utils.OllamaRequestBody
default BodyPublisher getBodyPublisher ()
 

Static Public Member Functions

static OllamaChatRequest builder ()
 

Additional Inherited Members

- Protected Attributes inherited from io.github.ollama4j.models.request.OllamaCommonRequest
String model
 
Object format
 
Map< String, Object > options
 
String template
 
boolean stream
 
String keepAlive
 

Detailed Description

Defines a Request to use against the ollama /api/chat endpoint.

See also
Generate Chat Completion

Definition at line 31 of file OllamaChatRequest.java.

Constructor & Destructor Documentation

◆ OllamaChatRequest() [1/2]

io.github.ollama4j.models.chat.OllamaChatRequest.OllamaChatRequest ( )

Definition at line 54 of file OllamaChatRequest.java.

◆ OllamaChatRequest() [2/2]

io.github.ollama4j.models.chat.OllamaChatRequest.OllamaChatRequest ( String model,
boolean think,
List< OllamaChatMessage > messages )

Definition at line 56 of file OllamaChatRequest.java.

Member Function Documentation

◆ build()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.build ( )

Definition at line 167 of file OllamaChatRequest.java.

◆ builder()

static OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.builder ( )
static

Definition at line 72 of file OllamaChatRequest.java.

◆ equals()

boolean io.github.ollama4j.models.chat.OllamaChatRequest.equals ( Object o)

Definition at line 63 of file OllamaChatRequest.java.

◆ reset()

void io.github.ollama4j.models.chat.OllamaChatRequest.reset ( )

Definition at line 171 of file OllamaChatRequest.java.

◆ withGetJsonResponse()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withGetJsonResponse ( )

Definition at line 132 of file OllamaChatRequest.java.

◆ withKeepAlive()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withKeepAlive ( String keepAlive)

Definition at line 147 of file OllamaChatRequest.java.

◆ withMessage() [1/3]

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withMessage ( OllamaChatMessageRole role,
String content )

Definition at line 83 of file OllamaChatRequest.java.

◆ withMessage() [2/3]

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withMessage ( OllamaChatMessageRole role,
String content,
List< OllamaChatToolCalls > toolCalls )

Definition at line 87 of file OllamaChatRequest.java.

◆ withMessage() [3/3]

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withMessage ( OllamaChatMessageRole role,
String content,
List< OllamaChatToolCalls > toolCalls,
List< File > images )

Definition at line 96 of file OllamaChatRequest.java.

◆ withMessages()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withMessages ( List< OllamaChatMessage > messages)

Definition at line 120 of file OllamaChatRequest.java.

◆ withModel()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withModel ( String model)

Definition at line 78 of file OllamaChatRequest.java.

◆ withOptions()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withOptions ( Options options)

Definition at line 125 of file OllamaChatRequest.java.

◆ withStreaming()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withStreaming ( )

Definition at line 142 of file OllamaChatRequest.java.

◆ withTemplate()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withTemplate ( String template)

Definition at line 137 of file OllamaChatRequest.java.

◆ withThinking()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withThinking ( boolean think)

Definition at line 152 of file OllamaChatRequest.java.

◆ withTools()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withTools ( List< Tools.Tool > tools)

Definition at line 162 of file OllamaChatRequest.java.

◆ withUseTools()

OllamaChatRequest io.github.ollama4j.models.chat.OllamaChatRequest.withUseTools ( boolean useTools)

Definition at line 157 of file OllamaChatRequest.java.

The documentation for this class was generated from the following file: