Package dev.langchain4j.model.vertexai

Class VertexAiScoringModel

java.lang.Object

dev.langchain4j.model.vertexai.VertexAiScoringModel

All Implemented Interfaces:

ScoringModel

public class VertexAiScoringModel
extends Object
implements ScoringModel

Implementation of a ScoringModel for the Google Cloud Vertex AI Ranking API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VertexAiScoringModel.Builder

Constructor Summary

Constructors

Constructor	Description
VertexAiScoringModel(String projectId, String projectNumber, String location, String model, String titleMetadataKey)	Constructor for the Vertex AI Ranker Scoring Model.

Method Summary

Modifier and Type	Method	Description
static VertexAiScoringModel.Builder	builder()
Response<List<Double>>	scoreAll(List<TextSegment> segments, String query)	Scores all provided TextSegments against a given query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.langchain4j.model.scoring.ScoringModel

score, score

Constructor Details

VertexAiScoringModel

public VertexAiScoringModel(String projectId,
 String projectNumber,
 String location,
 String model,
 String titleMetadataKey)

Constructor for the Vertex AI Ranker Scoring Model.

Parameters:

projectId - The Google Cloud Project ID.

projectNumber - The Google Cloud Project Number.

location - The Google Cloud Region.

model - The model to use

titleMetadataKey - The name of the key to use as a title.

Method Details

scoreAll

public Response<List<Double>> scoreAll(List<TextSegment> segments,
 String query)

Scores all provided TextSegments against a given query.

Specified by:

scoreAll in interface ScoringModel

Parameters:

segments - The list of TextSegments to score.

query - The query against which to score the segments.

Returns:

the list of scores. The order of scores corresponds to the order of TextSegments.

builder

public static VertexAiScoringModel.Builder builder()