Class RerankTextDetails

Details required for a rerank request.

Inheritance

object

RerankTextDetails

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 RerankTextDetails

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment to call into the Generative AI service LLMs.

Remarks

Required

Documents

Declaration

[Required(ErrorMessage = "Documents is required.")]
[JsonProperty(PropertyName = "documents")]
public List<string> Documents { get; set; }

Property Value

Type	Description
List<string>	A list of document strings to rerank based on the query asked.

Remarks

Required

Input

Declaration

[Required(ErrorMessage = "Input is required.")]
[JsonProperty(PropertyName = "input")]
public string Input { get; set; }

Property Value

Type	Description
string	Input query for search in the documents.

Remarks

Required

IsEcho

Declaration

[JsonProperty(PropertyName = "isEcho")]
public bool? IsEcho { get; set; }

Property Value

Type	Description
bool?	Whether or not to return the documents in the response.

MaxChunksPerDocument

Declaration

[JsonProperty(PropertyName = "maxChunksPerDocument")]
public int? MaxChunksPerDocument { get; set; }

Property Value

Type	Description
int?	The maximum number of chunks to produce internally from a document.

ServingMode

Declaration

[Required(ErrorMessage = "ServingMode is required.")]
[JsonProperty(PropertyName = "servingMode")]
public ServingMode ServingMode { get; set; }

Property Value

Type	Description
ServingMode

Remarks

Required

TopN

Declaration

[JsonProperty(PropertyName = "topN")]
public int? TopN { get; set; }

Property Value

Type	Description
int?	The number of most relevant documents or indices to return. Defaults to the length of the documents.