Google Cloud Ai Platform V1 Client - Class VertexRagStore (1.17.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class VertexRagStore.

Retrieve from Vertex RAG Store for grounding.

Generated from protobuf message google.cloud.aiplatform.v1.VertexRagStore

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ rag_resources
array< VertexRagStore\RagResource >

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

↳ similarity_top_k
int

Optional. Number of top k results to return from the selected corpora.

↳ vector_distance_threshold
float

Optional. Only return results with vector distance smaller than the threshold.

↳ rag_retrieval_config
RagRetrievalConfig

Optional. The retrieval config for the Rag query.

getRagResources

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

Returns
Type
Description

setRagResources

Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.

Parameter
Name
Description
Returns
Type
Description
$this

getSimilarityTopK

Optional. Number of top k results to return from the selected corpora.

Returns
Type
Description
int

hasSimilarityTopK

clearSimilarityTopK

setSimilarityTopK

Optional. Number of top k results to return from the selected corpora.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getVectorDistanceThreshold

Optional. Only return results with vector distance smaller than the threshold.

Returns
Type
Description
float

hasVectorDistanceThreshold

clearVectorDistanceThreshold

setVectorDistanceThreshold

Optional. Only return results with vector distance smaller than the threshold.

Parameter
Name
Description
var
float
Returns
Type
Description
$this

getRagRetrievalConfig

Optional. The retrieval config for the Rag query.

Returns
Type
Description

hasRagRetrievalConfig

clearRagRetrievalConfig

setRagRetrievalConfig

Optional. The retrieval config for the Rag query.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: