Class: Google::Apis::BigqueryV2::VectorSearchStatistics

Inherits:

Object

• Object
• Google::Apis::BigqueryV2::VectorSearchStatistics

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

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

Overview

Statistics for a vector search query. Populated as part of JobStatistics2.

Instance Attribute Summary

• #index_unused_reasons ⇒ Array<Google::Apis::BigqueryV2::IndexUnusedReason>

  When indexUsageMode is UNUSED or PARTIALLY_USED, this field explains why indexes were not used in all or part of the vector search query.

• #index_usage_mode ⇒ String

  Specifies the index usage mode for the query.

Instance Method Summary

• #initialize(**args) ⇒ VectorSearchStatistics constructor

  A new instance of VectorSearchStatistics.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ VectorSearchStatistics

Returns a new instance of VectorSearchStatistics.

# File 'lib/google/apis/bigquery_v2/classes.rb', line 11402

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

Instance Attribute Details

#index_unused_reasons ⇒ Array<Google::Apis::BigqueryV2::IndexUnusedReason>

When indexUsageMode is UNUSED or PARTIALLY_USED, this field explains why indexes were not used in all or part of the vector search query. If indexUsageMode is FULLY_USED, this field is not populated. Corresponds to the JSON property indexUnusedReasons

Returns:

• (Array<Google::Apis::BigqueryV2::IndexUnusedReason>)

# File 'lib/google/apis/bigquery_v2/classes.rb', line 11395

def index_unused_reasons
  @index_unused_reasons
end

#index_usage_mode ⇒ String

Specifies the index usage mode for the query. Corresponds to the JSON property indexUsageMode

Returns:

• (String)

# File 'lib/google/apis/bigquery_v2/classes.rb', line 11400

def index_usage_mode
  @index_usage_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/bigquery_v2/classes.rb', line 11407

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