ChatCompletionRequest (Java Client for OpenAI (ChatGPT) 0.23.0 API)

java.lang.Object
- dev.ai4j.openai4j.chat.ChatCompletionRequest

public final class ChatCompletionRequest
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ChatCompletionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ChatCompletionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ChatCompletionRequest.Builder`	`builder()`
`boolean`	`equals(Object another)`
`Double`	`frequencyPenalty()`
`FunctionCall`	`functionCall()` Deprecated.
`List<Function>`	`functions()` Deprecated.
`int`	`hashCode()`
`Map<String,Integer>`	`logitBias()`
`Integer`	`maxCompletionTokens()`
`Integer`	`maxTokens()`
`List<Message>`	`messages()`
`String`	`model()`
`Integer`	`n()`
`Boolean`	`parallelToolCalls()`
`Double`	`presencePenalty()`
`ResponseFormat`	`responseFormat()`
`Integer`	`seed()`
`List<String>`	`stop()`
`Boolean`	`stream()`
`StreamOptions`	`streamOptions()`
`Double`	`temperature()`
`Object`	`toolChoice()`
`List<Tool>`	`tools()`
`Double`	`topP()`
`String`	`toString()`
`String`	`user()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

model
```
public String model()
```

messages
```
public List<Message> messages()
```

temperature
```
public Double temperature()
```

topP
```
public Double topP()
```

n
```
public Integer n()
```

stream
```
public Boolean stream()
```

streamOptions
```
public StreamOptions streamOptions()
```

stop
```
public List<String> stop()
```

maxTokens
```
public Integer maxTokens()
```

maxCompletionTokens
```
public Integer maxCompletionTokens()
```

presencePenalty
```
public Double presencePenalty()
```

frequencyPenalty
```
public Double frequencyPenalty()
```

logitBias

public Map<String,Integer> logitBias()

user
```
public String user()
```

responseFormat

public ResponseFormat responseFormat()

seed
```
public Integer seed()
```

tools
```
public List<Tool> tools()
```

toolChoice
```
public Object toolChoice()
```

parallelToolCalls
```
public Boolean parallelToolCalls()
```

functions

@Deprecated
public List<Function> functions()

Deprecated.

functionCall

@Deprecated
public FunctionCall functionCall()

Deprecated.

equals

public boolean equals(Object another)

Overrides:: equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

builder

public static ChatCompletionRequest.Builder builder()

Class ChatCompletionRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

model

messages

temperature

topP

n

stream

streamOptions

stop

maxTokens

maxCompletionTokens

presencePenalty

frequencyPenalty

logitBias

user

responseFormat

seed

tools

toolChoice

parallelToolCalls

functions

functionCall

equals

hashCode

toString

builder