Vision AI V1 API - Class Google::Cloud::VisionAI::V1::Index (v0.1.0)

Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::Index.

An Index is a resource in Corpus. It contains an indexed version of the assets and annotations. When deployed to an endpoint, it will allow users to search the Index.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#deployed_indexes

def deployed_indexes() -> ::Array<::Google::Cloud::VisionAI::V1::DeployedIndexReference>
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Optional description of the index.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Optional description of the index.
Returns
  • (::String) — Optional. Optional description of the index.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. Optional user-specified display name of the index.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. Optional user-specified display name of the index.
Returns
  • (::String) — Optional. Optional user-specified display name of the index.

#entire_corpus

def entire_corpus() -> ::Boolean
Returns
  • (::Boolean) — Include all assets under the corpus.

#entire_corpus=

def entire_corpus=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Include all assets under the corpus.
Returns
  • (::Boolean) — Include all assets under the corpus.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}/indexes/{index_id}

#state

def state() -> ::Google::Cloud::VisionAI::V1::Index::State
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns