Package com.google.cloud.aiplatform.v1beta1

Interface ImportRagFilesConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ImportRagFilesConfig, ImportRagFilesConfig.Builder
@Generated public interface ImportRagFilesConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasGcsSource

      boolean hasGcsSource()
       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`
      .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 2;
      Returns:
      Whether the gcsSource field is set.

    • getGcsSource

      GcsSource getGcsSource()
       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`
      .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 2;
      Returns:
      The gcsSource.

    • getGcsSourceOrBuilder

      GcsSourceOrBuilder getGcsSourceOrBuilder()
       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`
      .google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 2;

    • hasGoogleDriveSource

      boolean hasGoogleDriveSource()
       Google Drive location. Supports importing individual files as
 well as Google Drive folders.
      .google.cloud.aiplatform.v1beta1.GoogleDriveSource google_drive_source = 3;
      Returns:
      Whether the googleDriveSource field is set.

    • getGoogleDriveSource

      GoogleDriveSource getGoogleDriveSource()
       Google Drive location. Supports importing individual files as
 well as Google Drive folders.
      .google.cloud.aiplatform.v1beta1.GoogleDriveSource google_drive_source = 3;
      Returns:
      The googleDriveSource.

    • getGoogleDriveSourceOrBuilder

      GoogleDriveSourceOrBuilder getGoogleDriveSourceOrBuilder()
       Google Drive location. Supports importing individual files as
 well as Google Drive folders.
      .google.cloud.aiplatform.v1beta1.GoogleDriveSource google_drive_source = 3;

    • hasSlackSource

      boolean hasSlackSource()
       Slack channels with their corresponding access tokens.
      .google.cloud.aiplatform.v1beta1.SlackSource slack_source = 6;
      Returns:
      Whether the slackSource field is set.

    • getSlackSource

      SlackSource getSlackSource()
       Slack channels with their corresponding access tokens.
      .google.cloud.aiplatform.v1beta1.SlackSource slack_source = 6;
      Returns:
      The slackSource.

    • getSlackSourceOrBuilder

      SlackSourceOrBuilder getSlackSourceOrBuilder()
       Slack channels with their corresponding access tokens.
      .google.cloud.aiplatform.v1beta1.SlackSource slack_source = 6;

    • hasJiraSource

      boolean hasJiraSource()
       Jira queries with their corresponding authentication.
      .google.cloud.aiplatform.v1beta1.JiraSource jira_source = 7;
      Returns:
      Whether the jiraSource field is set.

    • getJiraSource

      JiraSource getJiraSource()
       Jira queries with their corresponding authentication.
      .google.cloud.aiplatform.v1beta1.JiraSource jira_source = 7;
      Returns:
      The jiraSource.

    • getJiraSourceOrBuilder

      JiraSourceOrBuilder getJiraSourceOrBuilder()
       Jira queries with their corresponding authentication.
      .google.cloud.aiplatform.v1beta1.JiraSource jira_source = 7;

    • hasSharePointSources

      boolean hasSharePointSources()
       SharePoint sources.
      .google.cloud.aiplatform.v1beta1.SharePointSources share_point_sources = 13;
      Returns:
      Whether the sharePointSources field is set.

    • getSharePointSources

      SharePointSources getSharePointSources()
       SharePoint sources.
      .google.cloud.aiplatform.v1beta1.SharePointSources share_point_sources = 13;
      Returns:
      The sharePointSources.

    • getSharePointSourcesOrBuilder

      SharePointSourcesOrBuilder getSharePointSourcesOrBuilder()
       SharePoint sources.
      .google.cloud.aiplatform.v1beta1.SharePointSources share_point_sources = 13;

    • hasPartialFailureGcsSink

      @Deprecated boolean hasPartialFailureGcsSink()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.partial_failure_gcs_sink is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=718
       The Cloud Storage path to write partial failures to.
 Deprecated. Prefer to use `import_result_gcs_sink`.
      .google.cloud.aiplatform.v1beta1.GcsDestination partial_failure_gcs_sink = 11 [deprecated = true];
      Returns:
      Whether the partialFailureGcsSink field is set.

    • getPartialFailureGcsSink

      @Deprecated GcsDestination getPartialFailureGcsSink()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.partial_failure_gcs_sink is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=718
       The Cloud Storage path to write partial failures to.
 Deprecated. Prefer to use `import_result_gcs_sink`.
      .google.cloud.aiplatform.v1beta1.GcsDestination partial_failure_gcs_sink = 11 [deprecated = true];
      Returns:
      The partialFailureGcsSink.

    • getPartialFailureGcsSinkOrBuilder

      @Deprecated GcsDestinationOrBuilder getPartialFailureGcsSinkOrBuilder()
      Deprecated.
       The Cloud Storage path to write partial failures to.
 Deprecated. Prefer to use `import_result_gcs_sink`.
      .google.cloud.aiplatform.v1beta1.GcsDestination partial_failure_gcs_sink = 11 [deprecated = true];

    • hasPartialFailureBigquerySink

      @Deprecated boolean hasPartialFailureBigquerySink()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.partial_failure_bigquery_sink is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=727
       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`.
      .google.cloud.aiplatform.v1beta1.BigQueryDestination partial_failure_bigquery_sink = 12 [deprecated = true];
      Returns:
      Whether the partialFailureBigquerySink field is set.

    • getPartialFailureBigquerySink

      @Deprecated BigQueryDestination getPartialFailureBigquerySink()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.partial_failure_bigquery_sink is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=727
       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`.
      .google.cloud.aiplatform.v1beta1.BigQueryDestination partial_failure_bigquery_sink = 12 [deprecated = true];
      Returns:
      The partialFailureBigquerySink.

    • getPartialFailureBigquerySinkOrBuilder

      @Deprecated BigQueryDestinationOrBuilder getPartialFailureBigquerySinkOrBuilder()
      Deprecated.
       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`.
      .google.cloud.aiplatform.v1beta1.BigQueryDestination partial_failure_bigquery_sink = 12 [deprecated = true];

    • hasImportResultGcsSink

      boolean hasImportResultGcsSink()
       The Cloud Storage path to write import result to.
      .google.cloud.aiplatform.v1beta1.GcsDestination import_result_gcs_sink = 14;
      Returns:
      Whether the importResultGcsSink field is set.

    • getImportResultGcsSink

      GcsDestination getImportResultGcsSink()
       The Cloud Storage path to write import result to.
      .google.cloud.aiplatform.v1beta1.GcsDestination import_result_gcs_sink = 14;
      Returns:
      The importResultGcsSink.

    • getImportResultGcsSinkOrBuilder

      GcsDestinationOrBuilder getImportResultGcsSinkOrBuilder()
       The Cloud Storage path to write import result to.
      .google.cloud.aiplatform.v1beta1.GcsDestination import_result_gcs_sink = 14;

    • hasImportResultBigquerySink

      boolean hasImportResultBigquerySink()
       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.
      .google.cloud.aiplatform.v1beta1.BigQueryDestination import_result_bigquery_sink = 15;
      Returns:
      Whether the importResultBigquerySink field is set.

    • getImportResultBigquerySink

      BigQueryDestination getImportResultBigquerySink()
       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.
      .google.cloud.aiplatform.v1beta1.BigQueryDestination import_result_bigquery_sink = 15;
      Returns:
      The importResultBigquerySink.

    • getImportResultBigquerySinkOrBuilder

      BigQueryDestinationOrBuilder getImportResultBigquerySinkOrBuilder()
       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.
      .google.cloud.aiplatform.v1beta1.BigQueryDestination import_result_bigquery_sink = 15;

    • hasRagFileChunkingConfig

      @Deprecated boolean hasRagFileChunkingConfig()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.rag_file_chunking_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=746
       Specifies the size and overlap of chunks after importing RagFiles.
      .google.cloud.aiplatform.v1beta1.RagFileChunkingConfig rag_file_chunking_config = 4 [deprecated = true];
      Returns:
      Whether the ragFileChunkingConfig field is set.

    • getRagFileChunkingConfig

      @Deprecated RagFileChunkingConfig getRagFileChunkingConfig()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.rag_file_chunking_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=746
       Specifies the size and overlap of chunks after importing RagFiles.
      .google.cloud.aiplatform.v1beta1.RagFileChunkingConfig rag_file_chunking_config = 4 [deprecated = true];
      Returns:
      The ragFileChunkingConfig.

    • getRagFileChunkingConfigOrBuilder

      @Deprecated RagFileChunkingConfigOrBuilder getRagFileChunkingConfigOrBuilder()
      Deprecated.
       Specifies the size and overlap of chunks after importing RagFiles.
      .google.cloud.aiplatform.v1beta1.RagFileChunkingConfig rag_file_chunking_config = 4 [deprecated = true];

    • hasRagFileTransformationConfig

      boolean hasRagFileTransformationConfig()
       Specifies the transformation config for RagFiles.
      .google.cloud.aiplatform.v1beta1.RagFileTransformationConfig rag_file_transformation_config = 16;
      Returns:
      Whether the ragFileTransformationConfig field is set.

    • getRagFileTransformationConfig

      RagFileTransformationConfig getRagFileTransformationConfig()
       Specifies the transformation config for RagFiles.
      .google.cloud.aiplatform.v1beta1.RagFileTransformationConfig rag_file_transformation_config = 16;
      Returns:
      The ragFileTransformationConfig.

    • getRagFileTransformationConfigOrBuilder

      RagFileTransformationConfigOrBuilder getRagFileTransformationConfigOrBuilder()
       Specifies the transformation config for RagFiles.
      .google.cloud.aiplatform.v1beta1.RagFileTransformationConfig rag_file_transformation_config = 16;

    • hasRagFileParsingConfig

      boolean hasRagFileParsingConfig()
       Optional. Specifies the parsing config for RagFiles.
 RAG will use the default parser if this field is not set.
      .google.cloud.aiplatform.v1beta1.RagFileParsingConfig rag_file_parsing_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the ragFileParsingConfig field is set.

    • getRagFileParsingConfig

      RagFileParsingConfig getRagFileParsingConfig()
       Optional. Specifies the parsing config for RagFiles.
 RAG will use the default parser if this field is not set.
      .google.cloud.aiplatform.v1beta1.RagFileParsingConfig rag_file_parsing_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The ragFileParsingConfig.

    • getRagFileParsingConfigOrBuilder

      RagFileParsingConfigOrBuilder getRagFileParsingConfigOrBuilder()
       Optional. Specifies the parsing config for RagFiles.
 RAG will use the default parser if this field is not set.
      .google.cloud.aiplatform.v1beta1.RagFileParsingConfig rag_file_parsing_config = 8 [(.google.api.field_behavior) = OPTIONAL];

    • hasRagFileMetadataConfig

      @Deprecated boolean hasRagFileMetadataConfig()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.rag_file_metadata_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=759
       Specifies the metadata config for RagFiles.
 Including paths for metadata schema and metadata.
 Deprecated: Not in use.
      .google.cloud.aiplatform.v1beta1.RagFileMetadataConfig rag_file_metadata_config = 17 [deprecated = true];
      Returns:
      Whether the ragFileMetadataConfig field is set.

    • getRagFileMetadataConfig

      @Deprecated RagFileMetadataConfig getRagFileMetadataConfig()
      Deprecated.
      google.cloud.aiplatform.v1beta1.ImportRagFilesConfig.rag_file_metadata_config is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_data.proto;l=759
       Specifies the metadata config for RagFiles.
 Including paths for metadata schema and metadata.
 Deprecated: Not in use.
      .google.cloud.aiplatform.v1beta1.RagFileMetadataConfig rag_file_metadata_config = 17 [deprecated = true];
      Returns:
      The ragFileMetadataConfig.

    • getRagFileMetadataConfigOrBuilder

      @Deprecated RagFileMetadataConfigOrBuilder getRagFileMetadataConfigOrBuilder()
      Deprecated.
       Specifies the metadata config for RagFiles.
 Including paths for metadata schema and metadata.
 Deprecated: Not in use.
      .google.cloud.aiplatform.v1beta1.RagFileMetadataConfig rag_file_metadata_config = 17 [deprecated = true];

    • getMaxEmbeddingRequestsPerMin

      int getMaxEmbeddingRequestsPerMin()
       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.
      int32 max_embedding_requests_per_min = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The maxEmbeddingRequestsPerMin.

    • getGlobalMaxEmbeddingRequestsPerMin

      int getGlobalMaxEmbeddingRequestsPerMin()
       Optional. The max number of queries per minute that the indexing pipeline
 job is allowed to make to the embedding model specified in the project.
 Please follow the quota usage guideline of the embedding model you use to
 set the value properly.If this value is not specified,
 max_embedding_requests_per_min will be used by indexing pipeline job as the
 global limit.
      int32 global_max_embedding_requests_per_min = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The globalMaxEmbeddingRequestsPerMin.

    • getRebuildAnnIndex

      boolean getRebuildAnnIndex()
       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.
      bool rebuild_ann_index = 19;
      Returns:
      The rebuildAnnIndex.

    • getImportSourceCase

      ImportRagFilesConfig.ImportSourceCase getImportSourceCase()

    • getPartialFailureSinkCase

      ImportRagFilesConfig.PartialFailureSinkCase getPartialFailureSinkCase()

    • getImportResultSinkCase

      ImportRagFilesConfig.ImportResultSinkCase getImportResultSinkCase()