Show / Hide Table of Contents

Class GeneratedText

The text generated during each run.

Inheritance
object
GeneratedText
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiinferenceService.Models
Assembly: OCI.DotNetSDK.Generativeaiinference.dll
Syntax
public class GeneratedText

Properties

FinishReason

Declaration
[JsonProperty(PropertyName = "finishReason")]
public string FinishReason { get; set; }
Property Value
Type Description
string

The reason why the model stopped generating tokens.
A model stops generating tokens if the model hits a natural stop point or reaches a provided stop sequence.

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

A unique identifier for this text generation.

Remarks

Required

Likelihood

Declaration
[Required(ErrorMessage = "Likelihood is required.")]
[JsonProperty(PropertyName = "likelihood")]
public double Likelihood { get; set; }
Property Value
Type Description
double

The overall likelihood of the generated text.
When a large language model generates a new token for the output text, a likelihood is assigned to all tokens, where tokens with higher likelihoods are more likely to follow the current token. For example, it's more likely that the word favorite is followed by the word food or book rather than the word zebra. A lower likelihood means that it's less likely that token follows the current token.

Remarks

Required

Text

Declaration
[Required(ErrorMessage = "Text is required.")]
[JsonProperty(PropertyName = "text")]
public string Text { get; set; }
Property Value
Type Description
string

The generated text.

Remarks

Required

TokenLikelihoods

Declaration
[JsonProperty(PropertyName = "tokenLikelihoods")]
public List<TokenLikelihood> TokenLikelihoods { get; set; }
Property Value
Type Description
List<TokenLikelihood>

A collection of generated tokens and their corresponding likelihoods.

In this article
Back to top