Class: Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1RetrievalResultStep

Inherits:

Object

• Object
• Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1RetrievalResultStep

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.

Instance Attribute Summary

• #is_error ⇒ Boolean (also: #is_error?)

  Whether the retrieval resulted in an error.

Instance Method Summary

• #initialize(**args) ⇒ GenaiVertexV1beta1RetrievalResultStep constructor

  A new instance of GenaiVertexV1beta1RetrievalResultStep.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GenaiVertexV1beta1RetrievalResultStep

Returns a new instance of GenaiVertexV1beta1RetrievalResultStep.

# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4829

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#is_error ⇒ Boolean Also known as: is_error?

Whether the retrieval resulted in an error. Corresponds to the JSON property isError

Returns:

• (Boolean)

# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4826

def is_error
  @is_error
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4834

def update!(**args)
  @is_error = args[:is_error] if args.key?(:is_error)
end