SummarizeTextResult

class oci.generative_ai_inference.models.SummarizeTextResult(**kwargs)

Bases: object

Summarize text result to return to caller.

Methods:

__init__(**kwargs)

Initializes a new SummarizeTextResult object with values from keyword arguments.

Attributes:

id	[Required] Gets the id of this SummarizeTextResult.
input	Gets the input of this SummarizeTextResult.
model_id	Gets the model_id of this SummarizeTextResult.
model_version	Gets the model_version of this SummarizeTextResult.
summary	[Required] Gets the summary of this SummarizeTextResult.

__init__(**kwargs)

Initializes a new SummarizeTextResult object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• id (str) – The value to assign to the id property of this SummarizeTextResult.

• input (str) – The value to assign to the input property of this SummarizeTextResult.

• summary (str) – The value to assign to the summary property of this SummarizeTextResult.

• model_id (str) – The value to assign to the model_id property of this SummarizeTextResult.

• model_version (str) – The value to assign to the model_version property of this SummarizeTextResult.

property id

[Required] Gets the id of this SummarizeTextResult. A unique identifier for this SummarizeTextResult.

Returns

The id of this SummarizeTextResult.

Return type

str

property input

Gets the input of this SummarizeTextResult. The original input. Only included if “isEcho” set to true.

Returns

The input of this SummarizeTextResult.

Return type

str

property model_id

Gets the model_id of this SummarizeTextResult. The OCID of the model used in this inference request.

Returns

The model_id of this SummarizeTextResult.

Return type

str

property model_version

Gets the model_version of this SummarizeTextResult. The version of the model.

Returns

The model_version of this SummarizeTextResult.

Return type

str

property summary

[Required] Gets the summary of this SummarizeTextResult. Summary result corresponding to input.

Returns

The summary of this SummarizeTextResult.

Return type

str