Skip to main content

Type Alias: GatewayInferenceInputCreateRerankRequest

type GatewayInferenceInputCreateRerankRequest = {
model: string;
query: string;
documents: GatewayInferenceInputRerankDocument[];
top_n?: number;
return_documents?: boolean;
max_tokens_per_doc?: number;
priority?: number;
rank_fields?: string[];
truncation?: boolean;
parameters?: {
[key: string]: GatewayJsonValue;
};
};

Defined in: src/models/ai-gateway-inference.ts:5317

Portkey CreateRerankRequest; strict modeled input with explicit JSON extension maps.

Example​

`GatewayInferenceInputCreateRerankRequestSchema.parse(value);`

Properties​

model​

model: string;

Defined in: src/models/ai-gateway-inference.ts:5318


query​

query: string;

Defined in: src/models/ai-gateway-inference.ts:5319


documents​

documents: GatewayInferenceInputRerankDocument[];

Defined in: src/models/ai-gateway-inference.ts:5320


top_n?​

optional top_n?: number;

Defined in: src/models/ai-gateway-inference.ts:5321


return_documents?​

optional return_documents?: boolean;

Defined in: src/models/ai-gateway-inference.ts:5322


max_tokens_per_doc?​

optional max_tokens_per_doc?: number;

Defined in: src/models/ai-gateway-inference.ts:5323


priority?​

optional priority?: number;

Defined in: src/models/ai-gateway-inference.ts:5324


rank_fields?​

optional rank_fields?: string[];

Defined in: src/models/ai-gateway-inference.ts:5325


truncation?​

optional truncation?: boolean;

Defined in: src/models/ai-gateway-inference.ts:5326


parameters?​

optional parameters?: {
[key: string]: GatewayJsonValue;
};

Defined in: src/models/ai-gateway-inference.ts:5327

Index Signature​

[key: string]: GatewayJsonValue