RerankTextResult¶

class oci.generative_ai_inference.models.RerankTextResult(**kwargs)¶

Bases: object

The rerank response to return to the caller.

Methods

__init__(**kwargs) Initializes a new RerankTextResult object with values from keyword arguments.

Attributes

`document_ranks`	[Required] Gets the document_ranks of this RerankTextResult.
`id`	[Required] Gets the id of this RerankTextResult.
`model_id`	Gets the model_id of this RerankTextResult.
`model_version`	Gets the model_version of this RerankTextResult.

__init__(**kwargs)¶

Initializes a new RerankTextResult 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 RerankTextResult.
model_id (str) – The value to assign to the model_id property of this RerankTextResult.
model_version (str) – The value to assign to the model_version property of this RerankTextResult.
document_ranks (list[oci.generative_ai_inference.models.DocumentRank]) – The value to assign to the document_ranks property of this RerankTextResult.

document_ranks¶

[Required] Gets the document_ranks of this RerankTextResult. Top n documents with their index and relevance score.

Returns:	The document_ranks of this RerankTextResult.
Return type:	list[oci.generative_ai_inference.models.DocumentRank]

id¶

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

Returns:	The id of this RerankTextResult.
Return type:	str

model_id¶

Gets the model_id of this RerankTextResult. The OCID of the model used in the rerank request.

Returns:	The model_id of this RerankTextResult.
Return type:	str

model_version¶

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

Returns:	The model_version of this RerankTextResult.
Return type:	str