Cloud AI Platform v1beta1 API - Class RagContexts.Types.Context (1.0.0-beta12)

public sealed class RagContexts.Types.Context : IMessage<RagContexts.Types.Context>, IEquatable<RagContexts.Types.Context>, IDeepCloneable<RagContexts.Types.Context>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class RagContexts.Types.Context.

A context of the query.

Inheritance

object > RagContexts.Types.Context

Implements

IMessage RagContexts Types Context, IEquatable RagContexts Types Context, IDeepCloneable RagContexts Types Context, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

Context()

public Context()

Context(Context)

public Context(RagContexts.Types.Context other)

Parameter
Name	Description
`other`	`RagContextsTypesContext`

Properties

Distance

[Obsolete]
public double Distance { get; set; }

The distance between the query dense embedding vector and the context text vector.

Property Value
Type	Description
`double`

HasScore

public bool HasScore { get; }

Gets whether the "score" field is set

Property Value
Type	Description
`bool`

Score

public double Score { get; set; }

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 context 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 context. The larger the distance, the less relevant the context is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.

Property Value
Type	Description
`double`

SourceDisplayName

public string SourceDisplayName { get; set; }

The file display name.

Property Value
Type	Description
`string`

SourceUri

public string SourceUri { get; set; }

If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.

Property Value
Type	Description
`string`

SparseDistance

[Obsolete]
public double SparseDistance { get; set; }

The distance between the query sparse embedding vector and the context text vector.

Property Value
Type	Description
`double`

Text

public string Text { get; set; }

The text chunk.

Property Value
Type	Description
`string`