SemanticRerankResult interface

Package:

@azure/cosmos

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the result of a semantic reranking operation, including rerank scores, latency, token usage, and HTTP response headers.

Properties

diagnostics	Diagnostic information for the semantic rerank operation.
headers	HTTP response headers from the inference service.
latency	Latency information for the rerank operation.
rerankScores	The list of rerank scores for the documents.
tokenUsage	Token usage information for the rerank operation.

Property Details

diagnostics

Diagnostic information for the semantic rerank operation.

diagnostics: CosmosDiagnostics

Property Value

CosmosDiagnostics

headers

HTTP response headers from the inference service.

headers: Record<string, string>

Property Value

Record<string, string>

latency

Latency information for the rerank operation.

latency: undefined | Record<string, unknown>

Property Value

undefined | Record<string, unknown>

rerankScores

The list of rerank scores for the documents.

rerankScores: RerankScore[]

Property Value

RerankScore[]

tokenUsage

Token usage information for the rerank operation.

tokenUsage: undefined | Record<string, unknown>

Property Value

undefined | Record<string, unknown>