Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpus

Inherits:
Object
  • Object
show all
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

A RagCorpus is a RagFile container and a project can have multiple RagCorpora.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1RagCorpus

Returns a new instance of GoogleCloudAiplatformV1beta1RagCorpus.



36826
36827
36828
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36826

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

Instance Attribute Details

#corpus_status ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CorpusStatus

RagCorpus status. Corresponds to the JSON property corpusStatus

Returns:



36749
36750
36751
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36749

def corpus_status
  @corpus_status
end

#corpus_type_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagCorpusCorpusTypeConfig

The config for the corpus type of the RagCorpus. Corresponds to the JSON property corpusTypeConfig

Returns:



36754
36755
36756
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36754

def corpus_type_config
  @corpus_type_config
end

#create_time ⇒ String

Output only. Timestamp when this RagCorpus was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


36759
36760
36761
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36759

def create_time
  @create_time
end

#description ⇒ String

Optional. The description of the RagCorpus. Corresponds to the JSON property description

Returns:

  • (String) 


36764
36765
36766
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36764

def description
  @description
end

#display_name ⇒ String

Required. The display name of the RagCorpus. The name can be up to 128 characters long and can consist of any UTF-8 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


36770
36771
36772
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36770

def display_name
  @display_name
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. Corresponds to the JSON property encryptionSpec

Returns:



36776
36777
36778
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36776

def encryption_spec
  @encryption_spec
end

#name ⇒ String

Output only. The resource name of the RagCorpus. Corresponds to the JSON property name

Returns:

  • (String) 


36781
36782
36783
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36781

def name
  @name
end

#rag_embedding_model_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig

Config for the embedding model to use for RAG. Corresponds to the JSON property ragEmbeddingModelConfig

Returns:



36786
36787
36788
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36786

def rag_embedding_model_config
  @rag_embedding_model_config
end

#rag_files_count ⇒ Fixnum

Output only. Number of RagFiles in the RagCorpus. NOTE: This field is not populated in the response of VertexRagDataService.ListRagCorpora. Corresponds to the JSON property ragFilesCount

Returns:

  • (Fixnum) 


36792
36793
36794
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36792

def rag_files_count
  @rag_files_count
end

#rag_vector_db_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig

Config for the Vector DB to use for RAG. Corresponds to the JSON property ragVectorDbConfig

Returns:



36797
36798
36799
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36797

def rag_vector_db_config
  @rag_vector_db_config
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


36802
36803
36804
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36802

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


36808
36809
36810
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36808

def satisfies_pzs
  @satisfies_pzs
end

#update_time ⇒ String

Output only. Timestamp when this RagCorpus was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


36814
36815
36816
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36814

def update_time
  @update_time
end

#vector_db_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig

Config for the Vector DB to use for RAG. Corresponds to the JSON property vectorDbConfig

Returns:



36819
36820
36821
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36819

def vector_db_config
  @vector_db_config
end

#vertex_ai_search_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VertexAiSearchConfig

Config for the Vertex AI Search. Corresponds to the JSON property vertexAiSearchConfig

Returns:



36824
36825
36826
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36824

def vertex_ai_search_config
  @vertex_ai_search_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36831
36832
36833
36834
36835
36836
36837
36838
36839
36840
36841
36842
36843
36844
36845
36846
36847
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 36831

def update!(**args)
  @corpus_status = args[:corpus_status] if args.key?(:corpus_status)
  @corpus_type_config = args[:corpus_type_config] if args.key?(:corpus_type_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @name = args[:name] if args.key?(:name)
  @rag_embedding_model_config = args[:rag_embedding_model_config] if args.key?(:rag_embedding_model_config)
  @rag_files_count = args[:rag_files_count] if args.key?(:rag_files_count)
  @rag_vector_db_config = args[:rag_vector_db_config] if args.key?(:rag_vector_db_config)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @update_time = args[:update_time] if args.key?(:update_time)
  @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config)
  @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config)
end