Class SummarizeTextDetails
Details for the request to summarize text.
Inherited Members
Namespace: Oci.GenerativeaiinferenceService.Models
Assembly: OCI.DotNetSDK.Generativeaiinference.dll
Syntax
public class SummarizeTextDetailsProperties
AdditionalCommand
Declaration
[JsonProperty(PropertyName = "additionalCommand")]
public string AdditionalCommand { get; set; }Property Value
| Type | Description |
|---|---|
| string | A free-form instruction for modifying how the summaries get generated. Should complete the sentence "Generate a summary _". For example, "focusing on the next steps" or "written by Yoda". |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The OCID of compartment in which to call the Generative AI service to summarize text. |
Remarks
Required
Extractiveness
Declaration
[JsonProperty(PropertyName = "extractiveness")]
[JsonConverter(typeof(StringEnumConverter))]
public SummarizeTextDetails.ExtractivenessEnum? Extractiveness { get; set; }Property Value
| Type | Description |
|---|---|
| SummarizeTextDetails.ExtractivenessEnum? | Controls how close to the original text the summary is. High extractiveness summaries will lean towards reusing sentences verbatim, while low extractiveness summaries will tend to paraphrase more. |
Format
Declaration
[JsonProperty(PropertyName = "format")]
[JsonConverter(typeof(StringEnumConverter))]
public SummarizeTextDetails.FormatEnum? Format { get; set; }Property Value
| Type | Description |
|---|---|
| SummarizeTextDetails.FormatEnum? | Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points. If "AUTO" is selected, the best option will be picked based on the input text. |
Input
Declaration
[Required(ErrorMessage = "Input is required.")]
[JsonProperty(PropertyName = "input")]
public string Input { get; set; }Property Value
| Type | Description |
|---|---|
| string | The input string to be summarized. |
Remarks
Required
IsEcho
Declaration
[JsonProperty(PropertyName = "isEcho")]
public bool? IsEcho { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | Whether or not to include the original inputs in the response. |
Length
Declaration
[JsonProperty(PropertyName = "length")]
[JsonConverter(typeof(StringEnumConverter))]
public SummarizeTextDetails.LengthEnum? Length { get; set; }Property Value
| Type | Description |
|---|---|
| SummarizeTextDetails.LengthEnum? | Indicates the approximate length of the summary. If "AUTO" is selected, the best option will be picked based on the input text. |
ServingMode
Declaration
[Required(ErrorMessage = "ServingMode is required.")]
[JsonProperty(PropertyName = "servingMode")]
public ServingMode ServingMode { get; set; }Property Value
| Type | Description |
|---|---|
| ServingMode |
Remarks
Required
Temperature
Declaration
[JsonProperty(PropertyName = "temperature")]
public double Temperature { get; set; }Property Value
| Type | Description |
|---|---|
| double | A number that sets the randomness of the generated output. Lower temperatures mean less random generations.
|