com.launchableinc.openai.completion.CompletionChoice Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

Basic java objects for the OpenAI GPT APIs

There is a newer version: 0.4.0

package com.launchableinc.openai.completion;

import lombok.Data;

/**
 * A completion generated by OpenAI
 * 
 * https://beta.openai.com/docs/api-reference/completions/create
 */
@Data
public class CompletionChoice {

	/**
	 * The generated text. Will include the prompt if {@link CompletionRequest#echo } is true
	 */
	String text;

	/**
	 * This index of this completion in the returned list.
	 */
	Integer index;

	/**
	 * The log probabilities of the chosen tokens and the top {@link CompletionRequest#logprobs}
	 * tokens
	 */
	LogProbResult logprobs;

	/**
	 * The reason why GPT stopped generating, for example "length".
	 */
	String finish_reason;
}