Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Fact (v0.59.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Fact.

The fact used in grounding.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#query

def query() -> ::String
Returns
  • (::String) — Query that is used to retrieve this fact.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Query that is used to retrieve this fact.
Returns
  • (::String) — Query that is used to retrieve this fact.

#score

def score() -> ::Float
Returns
  • (::Float) — If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type.

    For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

#score=

def score=(value) -> ::Float
Parameter
  • value (::Float) — If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type.

    For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

Returns
  • (::Float) — If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type.

    For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

#summary

def summary() -> ::String
Returns
  • (::String) — If present, the summary/snippet of the fact.

#summary=

def summary=(value) -> ::String
Parameter
  • value (::String) — If present, the summary/snippet of the fact.
Returns
  • (::String) — If present, the summary/snippet of the fact.

#title

def title() -> ::String
Returns
  • (::String) — If present, it refers to the title of this fact.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — If present, it refers to the title of this fact.
Returns
  • (::String) — If present, it refers to the title of this fact.

#uri

def uri() -> ::String
Returns
  • (::String) — If present, this uri links to the source of the fact.

#uri=

def uri=(value) -> ::String
Parameter
  • value (::String) — If present, this uri links to the source of the fact.
Returns
  • (::String) — If present, this uri links to the source of the fact.

#vector_distance

def vector_distance() -> ::Float
Returns
  • (::Float) — If present, the distance between the query vector and this fact vector.

#vector_distance=

def vector_distance=(value) -> ::Float
Parameter
  • value (::Float) — If present, the distance between the query vector and this fact vector.
Returns
  • (::Float) — If present, the distance between the query vector and this fact vector.