Package nl.dannyj.mistral.models.completion

Class ChatCompletionResponse

java.lang.Object

nl.dannyj.mistral.models.completion.ChatCompletionResponse

All Implemented Interfaces:

Response

public class ChatCompletionResponse
extends Object
implements Response

The ChatCompletionResponse class represents a response from the Mistral API when creating a chat completion. Most of these fields are undocumented.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionResponse()
ChatCompletionResponse(String id, String object, long created, String model, List<Choice> choices, Usage usage)

Method Summary

Modifier and Type	Method	Description
List<Choice>	getChoices()	The generated completions.
long	getCreated()	The time the chat completion was created in seconds since the epoch.
String	getId()	Unique identifier for this response.
String	getModel()	The model used to generate the completion.
String	getObject()	Undocumented, seems to be the type of the response.
Usage	getUsage()	The tokens used to generate the completion.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionResponse

public ChatCompletionResponse(String id,
 String object,
 long created,
 String model,
 List<Choice> choices,
 Usage usage)

ChatCompletionResponse

public ChatCompletionResponse()

Method Details

getId

public String getId()

Unique identifier for this response.

Returns:

the id of the response.

getObject

public String getObject()

Undocumented, seems to be the type of the response.

getCreated

public long getCreated()

The time the chat completion was created in seconds since the epoch.

Returns:

the time the chat completion was created.

getModel

public String getModel()

The model used to generate the completion.

Returns:

the model used to generate the completion.

getChoices

public List<Choice> getChoices()

The generated completions.

Returns:

the generated completions.

getUsage

public Usage getUsage()

The tokens used to generate the completion.

Returns:

the amount of tokens used to generate the completion.

toString

public String toString()

Overrides:

toString in class Object