Package com.intellijava.core.model

Class OpenaiChatResponse

java.lang.Object

com.intellijava.core.model.BaseRemoteModel

com.intellijava.core.model.OpenaiChatResponse

public class OpenaiChatResponse
extends BaseRemoteModel

OpenaiChatResponse is a model class used to parse the response from the OpenAI ChatGPT API. choices, Usage and Message are nested classes.

Author:

github.com/Barqawiz

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenaiChatResponse.Choice	A nested class for the API response's choice represents the model output.
static class	OpenaiChatResponse.Message	Message represents a message exchanged in a chat session.
static class	OpenaiChatResponse.Usage	Usage is a nested class that represents a Usage object returned in the API response.

Constructor Summary

Constructors

Constructor	Description
OpenaiChatResponse()	OpenaiChatResponse default constructor.

Method Summary

Modifier and Type	Method	Description
List<OpenaiChatResponse.Choice>	getChoices()	Gets the choices property
long	getCreated()	Gets the timestamp for the API response.
String	getModel()	Gets the name of the language model
String	getObject()	Gets the object type of the API response.
OpenaiChatResponse.Usage	getUsage()	Gets the usage statistics for generating the API response.
void	setChoices(List<OpenaiChatResponse.Choice> choices)	Sets the choices property
void	setCreated(long created)	Set the timestamp for the API response.
void	setModel(String model)	Setsthe name of the language model
void	setObject(String object)	Sets the object type of the API response.
void	setUsage(OpenaiChatResponse.Usage usage)	Set the usage statistics for generating the API response.

Methods inherited from class com.intellijava.core.model.BaseRemoteModel

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OpenaiChatResponse

public OpenaiChatResponse()

OpenaiChatResponse default constructor.

Method Details

getObject

public String getObject()

Gets the object type of the API response.

Returns:

the value of object property

setObject

public void setObject(String object)

Sets the object type of the API response.

Parameters:

object - the new value of the object property

getCreated

public long getCreated()

Gets the timestamp for the API response.

Returns:

the value of created property

setCreated

public void setCreated(long created)

Set the timestamp for the API response.

Parameters:

created - the timestamp when the API request was created.

getModel

public String getModel()

Gets the name of the language model

Returns:

the model id or name used to generate the API response

setModel

public void setModel(String model)

Setsthe name of the language model

Parameters:

model - the model id or name used to generate the API response

getUsage

public OpenaiChatResponse.Usage getUsage()

Gets the usage statistics for generating the API response.

Returns:

the usage object that contains usage statistics of the API request

setUsage

public void setUsage(OpenaiChatResponse.Usage usage)

Set the usage statistics for generating the API response.

Parameters:

usage - the usage object that contains usage statistics of the API request

getChoices

public List<OpenaiChatResponse.Choice> getChoices()

Gets the choices property

Returns:

list of Choice objects that contain the generated completions and additional information

setChoices

public void setChoices(List<OpenaiChatResponse.Choice> choices)

Sets the choices property

Parameters:

choices - list of Choice objects that contain the generated completions and additional information