Class: Google::Cloud::AIPlatform::V1::ImportRagFilesConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb

Overview

Config for importing RagFiles.

Instance Attribute Summary collapse

Instance Attribute Details

#gcs_source ⇒ ::Google::Cloud::AIPlatform::V1::GcsSource

Returns Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats:

  • gs://bucket_name/my_directory/object_name/my_file.txt
  • gs://bucket_name/my_directory

Note: The following fields are mutually exclusive: gcs_source, google_drive_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::GcsSource) —

    Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats:

    • gs://bucket_name/my_directory/object_name/my_file.txt
    • gs://bucket_name/my_directory

    Note: The following fields are mutually exclusive: gcs_source, google_drive_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#google_drive_source ⇒ ::Google::Cloud::AIPlatform::V1::GoogleDriveSource

Returns Google Drive location. Supports importing individual files as well as Google Drive folders.

Note: The following fields are mutually exclusive: google_drive_source, gcs_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::GoogleDriveSource) —

    Google Drive location. Supports importing individual files as well as Google Drive folders.

    Note: The following fields are mutually exclusive: google_drive_source, gcs_source, slack_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#import_result_bigquery_sink ⇒ ::Google::Cloud::AIPlatform::V1::BigQueryDestination

Returns The BigQuery destination to write import result to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table.

Note: The following fields are mutually exclusive: import_result_bigquery_sink, import_result_gcs_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::BigQueryDestination) —

    The BigQuery destination to write import result to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table.

    Note: The following fields are mutually exclusive: import_result_bigquery_sink, import_result_gcs_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#import_result_gcs_sink ⇒ ::Google::Cloud::AIPlatform::V1::GcsDestination

Returns The Cloud Storage path to write import result to.

Note: The following fields are mutually exclusive: import_result_gcs_sink, import_result_bigquery_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::GcsDestination) —

    The Cloud Storage path to write import result to.

    Note: The following fields are mutually exclusive: import_result_gcs_sink, import_result_bigquery_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#jira_source ⇒ ::Google::Cloud::AIPlatform::V1::JiraSource

Returns Jira queries with their corresponding authentication.

Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::JiraSource) —

    Jira queries with their corresponding authentication.

    Note: The following fields are mutually exclusive: jira_source, gcs_source, google_drive_source, slack_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_embedding_requests_per_min ⇒ ::Integer

Returns Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.

Returns:

  • (::Integer) —

    Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#partial_failure_bigquery_sink ⇒ ::Google::Cloud::AIPlatform::V1::BigQueryDestination

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table. Deprecated. Prefer to use import_result_bq_sink.

Note: The following fields are mutually exclusive: partial_failure_bigquery_sink, partial_failure_gcs_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::BigQueryDestination) —

    The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table. Deprecated. Prefer to use import_result_bq_sink.

    Note: The following fields are mutually exclusive: partial_failure_bigquery_sink, partial_failure_gcs_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#partial_failure_gcs_sink ⇒ ::Google::Cloud::AIPlatform::V1::GcsDestination

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns The Cloud Storage path to write partial failures to. Deprecated. Prefer to use import_result_gcs_sink.

Note: The following fields are mutually exclusive: partial_failure_gcs_sink, partial_failure_bigquery_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::GcsDestination) —

    The Cloud Storage path to write partial failures to. Deprecated. Prefer to use import_result_gcs_sink.

    Note: The following fields are mutually exclusive: partial_failure_gcs_sink, partial_failure_bigquery_sink. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rag_file_parsing_config ⇒ ::Google::Cloud::AIPlatform::V1::RagFileParsingConfig

Returns Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set.

Returns:



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rag_file_transformation_config ⇒ ::Google::Cloud::AIPlatform::V1::RagFileTransformationConfig

Returns Specifies the transformation config for RagFiles.

Returns:



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rebuild_ann_index ⇒ ::Boolean

Returns Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with retrieval_strategy set to ANN. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API.

Default is false, i.e., index is not rebuilt.

Returns:

  • (::Boolean) —

    Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with retrieval_strategy set to ANN. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API.

    Default is false, i.e., index is not rebuilt.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#share_point_sources ⇒ ::Google::Cloud::AIPlatform::V1::SharePointSources

Returns SharePoint sources.

Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::SharePointSources) —

    SharePoint sources.

    Note: The following fields are mutually exclusive: share_point_sources, gcs_source, google_drive_source, slack_source, jira_source. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#slack_source ⇒ ::Google::Cloud::AIPlatform::V1::SlackSource

Returns Slack channels with their corresponding access tokens.

Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::SlackSource) —

    Slack channels with their corresponding access tokens.

    Note: The following fields are mutually exclusive: slack_source, gcs_source, google_drive_source, jira_source, share_point_sources. If a field in that set is populated, all other fields in the set will automatically be cleared.



543
544
545
546
 
# File 'proto_docs/google/cloud/aiplatform/v1/vertex_rag_data.rb', line 543

class ImportRagFilesConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end