google-apis-discoveryengine_v1beta 0.40.0 → 0.41.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -2834,6 +2834,26 @@ module Google
2834
2834
  end
2835
2835
  end
2836
2836
 
2837
+ # Grounding configuration.
2838
+ class GoogleCloudDiscoveryengineV1alphaGroundingConfig
2839
+ include Google::Apis::Core::Hashable
2840
+
2841
+ # Required. Name of the GroundingConfig, of the form `projects/`project`/
2842
+ # locations/`location`/groundingConfig`.
2843
+ # Corresponds to the JSON property `name`
2844
+ # @return [String]
2845
+ attr_accessor :name
2846
+
2847
+ def initialize(**args)
2848
+ update!(**args)
2849
+ end
2850
+
2851
+ # Update properties of this object
2852
+ def update!(**args)
2853
+ @name = args[:name] if args.key?(:name)
2854
+ end
2855
+ end
2856
+
2837
2857
  # Identity Provider Config.
2838
2858
  class GoogleCloudDiscoveryengineV1alphaIdpConfig
2839
2859
  include Google::Apis::Core::Hashable
@@ -2878,6 +2898,66 @@ module Google
2878
2898
  end
2879
2899
  end
2880
2900
 
2901
+ # Metadata related to the progress of the ImportCompletionSuggestions operation.
2902
+ # This will be returned by the google.longrunning.Operation.metadata field.
2903
+ class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
2904
+ include Google::Apis::Core::Hashable
2905
+
2906
+ # Operation create time.
2907
+ # Corresponds to the JSON property `createTime`
2908
+ # @return [String]
2909
+ attr_accessor :create_time
2910
+
2911
+ # Operation last update time. If the operation is done, this is also the finish
2912
+ # time.
2913
+ # Corresponds to the JSON property `updateTime`
2914
+ # @return [String]
2915
+ attr_accessor :update_time
2916
+
2917
+ def initialize(**args)
2918
+ update!(**args)
2919
+ end
2920
+
2921
+ # Update properties of this object
2922
+ def update!(**args)
2923
+ @create_time = args[:create_time] if args.key?(:create_time)
2924
+ @update_time = args[:update_time] if args.key?(:update_time)
2925
+ end
2926
+ end
2927
+
2928
+ # Response of the CompletionService.ImportCompletionSuggestions method. If the
2929
+ # long running operation is done, this message is returned by the google.
2930
+ # longrunning.Operations.response field if the operation is successful.
2931
+ class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
2932
+ include Google::Apis::Core::Hashable
2933
+
2934
+ # A sample of errors encountered while processing the request.
2935
+ # Corresponds to the JSON property `errorSamples`
2936
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
2937
+ attr_accessor :error_samples
2938
+
2939
+ # Count of CompletionSuggestions that failed to be imported.
2940
+ # Corresponds to the JSON property `failureCount`
2941
+ # @return [Fixnum]
2942
+ attr_accessor :failure_count
2943
+
2944
+ # Count of CompletionSuggestions successfully imported.
2945
+ # Corresponds to the JSON property `successCount`
2946
+ # @return [Fixnum]
2947
+ attr_accessor :success_count
2948
+
2949
+ def initialize(**args)
2950
+ update!(**args)
2951
+ end
2952
+
2953
+ # Update properties of this object
2954
+ def update!(**args)
2955
+ @error_samples = args[:error_samples] if args.key?(:error_samples)
2956
+ @failure_count = args[:failure_count] if args.key?(:failure_count)
2957
+ @success_count = args[:success_count] if args.key?(:success_count)
2958
+ end
2959
+ end
2960
+
2881
2961
  # Metadata related to the progress of the ImportDocuments operation. This is
2882
2962
  # returned by the google.longrunning.Operation.metadata field.
2883
2963
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -3649,6 +3729,11 @@ module Google
3649
3729
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
3650
3730
  attr_accessor :error_samples
3651
3731
 
3732
+ # The metrics of the trained model.
3733
+ # Corresponds to the JSON property `metrics`
3734
+ # @return [Hash<String,Float>]
3735
+ attr_accessor :metrics
3736
+
3652
3737
  # The trained model status. Possible values are: * **bad-data**: The training
3653
3738
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
3654
3739
  # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
@@ -3665,6 +3750,7 @@ module Google
3665
3750
  def update!(**args)
3666
3751
  @error_config = args[:error_config] if args.key?(:error_config)
3667
3752
  @error_samples = args[:error_samples] if args.key?(:error_samples)
3753
+ @metrics = args[:metrics] if args.key?(:metrics)
3668
3754
  @model_status = args[:model_status] if args.key?(:model_status)
3669
3755
  end
3670
3756
  end
@@ -3905,6 +3991,228 @@ module Google
3905
3991
  end
3906
3992
  end
3907
3993
 
3994
+ # The Bigtable Options object that contains information to support the import.
3995
+ class GoogleCloudDiscoveryengineV1betaBigtableOptions
3996
+ include Google::Apis::Core::Hashable
3997
+
3998
+ # The mapping from family names to an object that contains column families level
3999
+ # information for the given column family. If a family is not present in this
4000
+ # map it will be ignored.
4001
+ # Corresponds to the JSON property `families`
4002
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily>]
4003
+ attr_accessor :families
4004
+
4005
+ # The field name used for saving row key value in the UCS document. The name has
4006
+ # to match a-zA-Z0-9*
4007
+ # Corresponds to the JSON property `keyFieldName`
4008
+ # @return [String]
4009
+ attr_accessor :key_field_name
4010
+
4011
+ def initialize(**args)
4012
+ update!(**args)
4013
+ end
4014
+
4015
+ # Update properties of this object
4016
+ def update!(**args)
4017
+ @families = args[:families] if args.key?(:families)
4018
+ @key_field_name = args[:key_field_name] if args.key?(:key_field_name)
4019
+ end
4020
+ end
4021
+
4022
+ #
4023
+ class GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn
4024
+ include Google::Apis::Core::Hashable
4025
+
4026
+ # Optional. The encoding mode of the values when the type is not STRING.
4027
+ # Acceptable encoding values are: TEXT - indicates values are alphanumeric text
4028
+ # strings. BINARY - indicates values are encoded using HBase Bytes.toBytes
4029
+ # family of functions. This can be overridden for a specific column by listing
4030
+ # that column in 'columns' and specifying an encoding for it.
4031
+ # Corresponds to the JSON property `encoding`
4032
+ # @return [String]
4033
+ attr_accessor :encoding
4034
+
4035
+ # The field name to use for this column in the UCS document. The name has to
4036
+ # match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with
4037
+ # best effort. However, field name collisions could happen, where parsing
4038
+ # behavior is undefined.
4039
+ # Corresponds to the JSON property `fieldName`
4040
+ # @return [String]
4041
+ attr_accessor :field_name
4042
+
4043
+ # Required. Qualifier of the column. If cannot decode with utf-8, store a base-
4044
+ # 64 encoded string.
4045
+ # Corresponds to the JSON property `qualifier`
4046
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
4047
+ # @return [String]
4048
+ attr_accessor :qualifier
4049
+
4050
+ # Optional. The type of values in this column family. The values are expected to
4051
+ # be encoded using HBase Bytes.toBytes function when the encoding value is set
4052
+ # to BINARY.
4053
+ # Corresponds to the JSON property `type`
4054
+ # @return [String]
4055
+ attr_accessor :type
4056
+
4057
+ def initialize(**args)
4058
+ update!(**args)
4059
+ end
4060
+
4061
+ # Update properties of this object
4062
+ def update!(**args)
4063
+ @encoding = args[:encoding] if args.key?(:encoding)
4064
+ @field_name = args[:field_name] if args.key?(:field_name)
4065
+ @qualifier = args[:qualifier] if args.key?(:qualifier)
4066
+ @type = args[:type] if args.key?(:type)
4067
+ end
4068
+ end
4069
+
4070
+ #
4071
+ class GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily
4072
+ include Google::Apis::Core::Hashable
4073
+
4074
+ # The list of objects that contains column level information for each column. If
4075
+ # a column is not present in this list it will be ignored.
4076
+ # Corresponds to the JSON property `columns`
4077
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn>]
4078
+ attr_accessor :columns
4079
+
4080
+ # Optional. The encoding mode of the values when the type is not STRING.
4081
+ # Acceptable encoding values are: TEXT - indicates values are alphanumeric text
4082
+ # strings. BINARY - indicates values are encoded using HBase Bytes.toBytes
4083
+ # family of functions. This can be overridden for a specific column by listing
4084
+ # that column in 'columns' and specifying an encoding for it.
4085
+ # Corresponds to the JSON property `encoding`
4086
+ # @return [String]
4087
+ attr_accessor :encoding
4088
+
4089
+ # The field name to use for this column family in the UCS document. The name has
4090
+ # to match a-zA-Z0-9* If not set, we will parse it from the family name with
4091
+ # best effort. However, due to difference naming pattern, there could be field
4092
+ # name collisions, where parsing behavior is undefined.
4093
+ # Corresponds to the JSON property `fieldName`
4094
+ # @return [String]
4095
+ attr_accessor :field_name
4096
+
4097
+ # Optional. The type of values in this column family. The values are expected to
4098
+ # be encoded using HBase Bytes.toBytes function when the encoding value is set
4099
+ # to BINARY.
4100
+ # Corresponds to the JSON property `type`
4101
+ # @return [String]
4102
+ attr_accessor :type
4103
+
4104
+ def initialize(**args)
4105
+ update!(**args)
4106
+ end
4107
+
4108
+ # Update properties of this object
4109
+ def update!(**args)
4110
+ @columns = args[:columns] if args.key?(:columns)
4111
+ @encoding = args[:encoding] if args.key?(:encoding)
4112
+ @field_name = args[:field_name] if args.key?(:field_name)
4113
+ @type = args[:type] if args.key?(:type)
4114
+ end
4115
+ end
4116
+
4117
+ # The Cloud Bigtable source for importing data
4118
+ class GoogleCloudDiscoveryengineV1betaBigtableSource
4119
+ include Google::Apis::Core::Hashable
4120
+
4121
+ # The Bigtable Options object that contains information to support the import.
4122
+ # Corresponds to the JSON property `bigtableOptions`
4123
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigtableOptions]
4124
+ attr_accessor :bigtable_options
4125
+
4126
+ # Required. The instance ID of the Cloud Bigtable that needs to be exported.
4127
+ # Corresponds to the JSON property `instanceId`
4128
+ # @return [String]
4129
+ attr_accessor :instance_id
4130
+
4131
+ # The project ID (can be project # or ID) that the Bigtable source is in with a
4132
+ # length limit of 128 characters. If not specified, inherits the project ID from
4133
+ # the parent request.
4134
+ # Corresponds to the JSON property `projectId`
4135
+ # @return [String]
4136
+ attr_accessor :project_id
4137
+
4138
+ # Required. The table ID of the Cloud Bigtable that needs to be exported.
4139
+ # Corresponds to the JSON property `tableId`
4140
+ # @return [String]
4141
+ attr_accessor :table_id
4142
+
4143
+ def initialize(**args)
4144
+ update!(**args)
4145
+ end
4146
+
4147
+ # Update properties of this object
4148
+ def update!(**args)
4149
+ @bigtable_options = args[:bigtable_options] if args.key?(:bigtable_options)
4150
+ @instance_id = args[:instance_id] if args.key?(:instance_id)
4151
+ @project_id = args[:project_id] if args.key?(:project_id)
4152
+ @table_id = args[:table_id] if args.key?(:table_id)
4153
+ end
4154
+ end
4155
+
4156
+ # Cloud SQL source import data from.
4157
+ class GoogleCloudDiscoveryengineV1betaCloudSqlSource
4158
+ include Google::Apis::Core::Hashable
4159
+
4160
+ # Required. The Cloud SQL database to copy the data from with a length limit of
4161
+ # 256 characters.
4162
+ # Corresponds to the JSON property `databaseId`
4163
+ # @return [String]
4164
+ attr_accessor :database_id
4165
+
4166
+ # Optional. Intermediate Cloud Storage directory used for the import with a
4167
+ # length limit of 2,000 characters. Can be specified if one wants to have the
4168
+ # Cloud SQL export to a specific Cloud Storage directory. Please ensure that the
4169
+ # Cloud SQL service account has the necessary GCS Storage Admin permissions to
4170
+ # access the specified GCS directory.
4171
+ # Corresponds to the JSON property `gcsStagingDir`
4172
+ # @return [String]
4173
+ attr_accessor :gcs_staging_dir
4174
+
4175
+ # Required. The Cloud SQL instance to copy the data from with a length limit of
4176
+ # 256 characters.
4177
+ # Corresponds to the JSON property `instanceId`
4178
+ # @return [String]
4179
+ attr_accessor :instance_id
4180
+
4181
+ # Optional. Option for serverless export. Enabling this option will incur
4182
+ # additional cost. More info: https://cloud.google.com/sql/pricing#serverless
4183
+ # Corresponds to the JSON property `offload`
4184
+ # @return [Boolean]
4185
+ attr_accessor :offload
4186
+ alias_method :offload?, :offload
4187
+
4188
+ # Optional. The project ID (can be project # or ID) that the Cloud SQL source is
4189
+ # in with a length limit of 128 characters. If not specified, inherits the
4190
+ # project ID from the parent request.
4191
+ # Corresponds to the JSON property `projectId`
4192
+ # @return [String]
4193
+ attr_accessor :project_id
4194
+
4195
+ # Required. The Cloud SQL table to copy the data from with a length limit of 256
4196
+ # characters.
4197
+ # Corresponds to the JSON property `tableId`
4198
+ # @return [String]
4199
+ attr_accessor :table_id
4200
+
4201
+ def initialize(**args)
4202
+ update!(**args)
4203
+ end
4204
+
4205
+ # Update properties of this object
4206
+ def update!(**args)
4207
+ @database_id = args[:database_id] if args.key?(:database_id)
4208
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
4209
+ @instance_id = args[:instance_id] if args.key?(:instance_id)
4210
+ @offload = args[:offload] if args.key?(:offload)
4211
+ @project_id = args[:project_id] if args.key?(:project_id)
4212
+ @table_id = args[:table_id] if args.key?(:table_id)
4213
+ end
4214
+ end
4215
+
3908
4216
  # Response message for CompletionService.CompleteQuery method.
3909
4217
  class GoogleCloudDiscoveryengineV1betaCompleteQueryResponse
3910
4218
  include Google::Apis::Core::Hashable
@@ -5276,6 +5584,80 @@ module Google
5276
5584
  end
5277
5585
  end
5278
5586
 
5587
+ # Cloud FhirStore source import data from.
5588
+ class GoogleCloudDiscoveryengineV1betaFhirStoreSource
5589
+ include Google::Apis::Core::Hashable
5590
+
5591
+ # Required. The full resource name of the FHIR store to import data from, in the
5592
+ # format of `projects/`project`/locations/`location`/datasets/`dataset`/
5593
+ # fhirStores/`fhir_store``.
5594
+ # Corresponds to the JSON property `fhirStore`
5595
+ # @return [String]
5596
+ attr_accessor :fhir_store
5597
+
5598
+ # Intermediate Cloud Storage directory used for the import with a length limit
5599
+ # of 2,000 characters. Can be specified if one wants to have the FhirStore
5600
+ # export to a specific Cloud Storage directory.
5601
+ # Corresponds to the JSON property `gcsStagingDir`
5602
+ # @return [String]
5603
+ attr_accessor :gcs_staging_dir
5604
+
5605
+ def initialize(**args)
5606
+ update!(**args)
5607
+ end
5608
+
5609
+ # Update properties of this object
5610
+ def update!(**args)
5611
+ @fhir_store = args[:fhir_store] if args.key?(:fhir_store)
5612
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
5613
+ end
5614
+ end
5615
+
5616
+ # Firestore source import data from.
5617
+ class GoogleCloudDiscoveryengineV1betaFirestoreSource
5618
+ include Google::Apis::Core::Hashable
5619
+
5620
+ # Required. The Firestore collection to copy the data from with a length limit
5621
+ # of 1500 characters.
5622
+ # Corresponds to the JSON property `collectionId`
5623
+ # @return [String]
5624
+ attr_accessor :collection_id
5625
+
5626
+ # Required. The Firestore database to copy the data from with a length limit of
5627
+ # 256 characters.
5628
+ # Corresponds to the JSON property `databaseId`
5629
+ # @return [String]
5630
+ attr_accessor :database_id
5631
+
5632
+ # Optional. Intermediate Cloud Storage directory used for the import with a
5633
+ # length limit of 2,000 characters. Can be specified if one wants to have the
5634
+ # Firestore export to a specific Cloud Storage directory. Please ensure that the
5635
+ # Firestore service account has the necessary GCS Storage Admin permissions to
5636
+ # access the specified GCS directory.
5637
+ # Corresponds to the JSON property `gcsStagingDir`
5638
+ # @return [String]
5639
+ attr_accessor :gcs_staging_dir
5640
+
5641
+ # Optional. The project ID (can be project # or ID) that the Cloud SQL source is
5642
+ # in with a length limit of 128 characters. If not specified, inherits the
5643
+ # project ID from the parent request.
5644
+ # Corresponds to the JSON property `projectId`
5645
+ # @return [String]
5646
+ attr_accessor :project_id
5647
+
5648
+ def initialize(**args)
5649
+ update!(**args)
5650
+ end
5651
+
5652
+ # Update properties of this object
5653
+ def update!(**args)
5654
+ @collection_id = args[:collection_id] if args.key?(:collection_id)
5655
+ @database_id = args[:database_id] if args.key?(:database_id)
5656
+ @gcs_staging_dir = args[:gcs_staging_dir] if args.key?(:gcs_staging_dir)
5657
+ @project_id = args[:project_id] if args.key?(:project_id)
5658
+ end
5659
+ end
5660
+
5279
5661
  # Cloud Storage location for input content.
5280
5662
  class GoogleCloudDiscoveryengineV1betaGcsSource
5281
5663
  include Google::Apis::Core::Hashable
@@ -5316,6 +5698,26 @@ module Google
5316
5698
  end
5317
5699
  end
5318
5700
 
5701
+ # Grounding configuration.
5702
+ class GoogleCloudDiscoveryengineV1betaGroundingConfig
5703
+ include Google::Apis::Core::Hashable
5704
+
5705
+ # Required. Name of the GroundingConfig, of the form `projects/`project`/
5706
+ # locations/`location`/groundingConfig`.
5707
+ # Corresponds to the JSON property `name`
5708
+ # @return [String]
5709
+ attr_accessor :name
5710
+
5711
+ def initialize(**args)
5712
+ update!(**args)
5713
+ end
5714
+
5715
+ # Update properties of this object
5716
+ def update!(**args)
5717
+ @name = args[:name] if args.key?(:name)
5718
+ end
5719
+ end
5720
+
5319
5721
  # Metadata related to the progress of the ImportDocuments operation. This is
5320
5722
  # returned by the google.longrunning.Operation.metadata field.
5321
5723
  class GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata
@@ -5364,10 +5766,11 @@ module Google
5364
5766
  # payload, where IDs may not be consistent during multiple imports. In which
5365
5767
  # case ReconciliationMode.FULL is highly recommended to avoid duplicate contents.
5366
5768
  # If unset or set to `false`, Document.ids have to be specified using id_field,
5367
- # otherwise, documents without IDs fail to be imported. Only set this field when
5368
- # using GcsSource or BigQuerySource, and when GcsSource.data_schema or
5369
- # BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an
5370
- # INVALID_ARGUMENT error is thrown.
5769
+ # otherwise, documents without IDs fail to be imported. Supported data sources: *
5770
+ # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
5771
+ # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
5772
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
5773
+ # SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource
5371
5774
  # Corresponds to the JSON property `autoGenerateIds`
5372
5775
  # @return [Boolean]
5373
5776
  attr_accessor :auto_generate_ids
@@ -5378,29 +5781,51 @@ module Google
5378
5781
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigQuerySource]
5379
5782
  attr_accessor :bigquery_source
5380
5783
 
5784
+ # The Cloud Bigtable source for importing data
5785
+ # Corresponds to the JSON property `bigtableSource`
5786
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaBigtableSource]
5787
+ attr_accessor :bigtable_source
5788
+
5789
+ # Cloud SQL source import data from.
5790
+ # Corresponds to the JSON property `cloudSqlSource`
5791
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCloudSqlSource]
5792
+ attr_accessor :cloud_sql_source
5793
+
5381
5794
  # Configuration of destination for Import related errors.
5382
5795
  # Corresponds to the JSON property `errorConfig`
5383
5796
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaImportErrorConfig]
5384
5797
  attr_accessor :error_config
5385
5798
 
5799
+ # Cloud FhirStore source import data from.
5800
+ # Corresponds to the JSON property `fhirStoreSource`
5801
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFhirStoreSource]
5802
+ attr_accessor :fhir_store_source
5803
+
5804
+ # Firestore source import data from.
5805
+ # Corresponds to the JSON property `firestoreSource`
5806
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaFirestoreSource]
5807
+ attr_accessor :firestore_source
5808
+
5386
5809
  # Cloud Storage location for input content.
5387
5810
  # Corresponds to the JSON property `gcsSource`
5388
5811
  # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaGcsSource]
5389
5812
  attr_accessor :gcs_source
5390
5813
 
5391
- # The field in the Cloud Storage and BigQuery sources that indicates the unique
5392
- # IDs of the documents. For GcsSource it is the key of the JSON field. For
5393
- # instance, `my_id` for JSON ``"my_id": "some_uuid"``. For BigQuerySource it is
5394
- # the column name of the BigQuery table where the unique ids are stored. The
5395
- # values of the JSON field or the BigQuery column are used as the Document.ids.
5396
- # The JSON field or the BigQuery column must be of string type, and the values
5397
- # must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/
5398
- # rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to
5399
- # be imported. Only set this field when using GcsSource or BigQuerySource, and
5400
- # when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only
5401
- # set this field when auto_generate_ids is unset or set as `false`. Otherwise,
5402
- # an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is
5403
- # used when importing from the allowed data sources.
5814
+ # The field indicates the ID field or column to be used as unique IDs of the
5815
+ # documents. For GcsSource it is the key of the JSON field. For instance, `my_id`
5816
+ # for JSON ``"my_id": "some_uuid"``. For others, it may be the column name of
5817
+ # the table where the unique ids are stored. The values of the JSON field or the
5818
+ # table column are used as the Document.ids. The JSON field or the table column
5819
+ # must be of string type, and the values must be set as valid strings conform to
5820
+ # [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
5821
+ # Otherwise, documents without valid IDs fail to be imported. Only set this
5822
+ # field when auto_generate_ids is unset or set as `false`. Otherwise, an
5823
+ # INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is
5824
+ # used when importing from the allowed data sources. Supported data sources: *
5825
+ # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
5826
+ # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
5827
+ # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
5828
+ # SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource
5404
5829
  # Corresponds to the JSON property `idField`
5405
5830
  # @return [String]
5406
5831
  attr_accessor :id_field
@@ -5416,6 +5841,11 @@ module Google
5416
5841
  # @return [String]
5417
5842
  attr_accessor :reconciliation_mode
5418
5843
 
5844
+ # The Spanner source for importing data
5845
+ # Corresponds to the JSON property `spannerSource`
5846
+ # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSpannerSource]
5847
+ attr_accessor :spanner_source
5848
+
5419
5849
  def initialize(**args)
5420
5850
  update!(**args)
5421
5851
  end
@@ -5424,11 +5854,16 @@ module Google
5424
5854
  def update!(**args)
5425
5855
  @auto_generate_ids = args[:auto_generate_ids] if args.key?(:auto_generate_ids)
5426
5856
  @bigquery_source = args[:bigquery_source] if args.key?(:bigquery_source)
5857
+ @bigtable_source = args[:bigtable_source] if args.key?(:bigtable_source)
5858
+ @cloud_sql_source = args[:cloud_sql_source] if args.key?(:cloud_sql_source)
5427
5859
  @error_config = args[:error_config] if args.key?(:error_config)
5860
+ @fhir_store_source = args[:fhir_store_source] if args.key?(:fhir_store_source)
5861
+ @firestore_source = args[:firestore_source] if args.key?(:firestore_source)
5428
5862
  @gcs_source = args[:gcs_source] if args.key?(:gcs_source)
5429
5863
  @id_field = args[:id_field] if args.key?(:id_field)
5430
5864
  @inline_source = args[:inline_source] if args.key?(:inline_source)
5431
5865
  @reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode)
5866
+ @spanner_source = args[:spanner_source] if args.key?(:spanner_source)
5432
5867
  end
5433
5868
  end
5434
5869
 
@@ -6084,6 +6519,19 @@ module Google
6084
6519
  end
6085
6520
  end
6086
6521
 
6522
+ # Request for pausing training of an engine.
6523
+ class GoogleCloudDiscoveryengineV1betaPauseEngineRequest
6524
+ include Google::Apis::Core::Hashable
6525
+
6526
+ def initialize(**args)
6527
+ update!(**args)
6528
+ end
6529
+
6530
+ # Update properties of this object
6531
+ def update!(**args)
6532
+ end
6533
+ end
6534
+
6087
6535
  # Metadata related to the progress of the PurgeDocuments operation. This will be
6088
6536
  # returned by the google.longrunning.Operation.metadata field.
6089
6537
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -6251,6 +6699,112 @@ module Google
6251
6699
  end
6252
6700
  end
6253
6701
 
6702
+ # Request message for RankService.Rank method.
6703
+ class GoogleCloudDiscoveryengineV1betaRankRequest
6704
+ include Google::Apis::Core::Hashable
6705
+
6706
+ # If true, the response will contain only record ID and score. By default, it is
6707
+ # false, the response will contain record details.
6708
+ # Corresponds to the JSON property `ignoreRecordDetailsInResponse`
6709
+ # @return [Boolean]
6710
+ attr_accessor :ignore_record_details_in_response
6711
+ alias_method :ignore_record_details_in_response?, :ignore_record_details_in_response
6712
+
6713
+ # The identifier of the model to use. It is one of: * `semantic-ranker-512@
6714
+ # latest`: Semantic ranking model with maxiumn input token size 512. It is set
6715
+ # to `semantic-ranker-512@latest` by default if unspecified.
6716
+ # Corresponds to the JSON property `model`
6717
+ # @return [String]
6718
+ attr_accessor :model
6719
+
6720
+ # The query to use.
6721
+ # Corresponds to the JSON property `query`
6722
+ # @return [String]
6723
+ attr_accessor :query
6724
+
6725
+ # Required. A list of records to rank.
6726
+ # Corresponds to the JSON property `records`
6727
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankingRecord>]
6728
+ attr_accessor :records
6729
+
6730
+ # The number of results to return. If this is unset or no bigger than zero,
6731
+ # returns all results.
6732
+ # Corresponds to the JSON property `topN`
6733
+ # @return [Fixnum]
6734
+ attr_accessor :top_n
6735
+
6736
+ def initialize(**args)
6737
+ update!(**args)
6738
+ end
6739
+
6740
+ # Update properties of this object
6741
+ def update!(**args)
6742
+ @ignore_record_details_in_response = args[:ignore_record_details_in_response] if args.key?(:ignore_record_details_in_response)
6743
+ @model = args[:model] if args.key?(:model)
6744
+ @query = args[:query] if args.key?(:query)
6745
+ @records = args[:records] if args.key?(:records)
6746
+ @top_n = args[:top_n] if args.key?(:top_n)
6747
+ end
6748
+ end
6749
+
6750
+ # Response message for RankService.Rank method.
6751
+ class GoogleCloudDiscoveryengineV1betaRankResponse
6752
+ include Google::Apis::Core::Hashable
6753
+
6754
+ # A list of records sorted by descending score.
6755
+ # Corresponds to the JSON property `records`
6756
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRankingRecord>]
6757
+ attr_accessor :records
6758
+
6759
+ def initialize(**args)
6760
+ update!(**args)
6761
+ end
6762
+
6763
+ # Update properties of this object
6764
+ def update!(**args)
6765
+ @records = args[:records] if args.key?(:records)
6766
+ end
6767
+ end
6768
+
6769
+ # Record message for RankService.Rank method.
6770
+ class GoogleCloudDiscoveryengineV1betaRankingRecord
6771
+ include Google::Apis::Core::Hashable
6772
+
6773
+ # The content of the record. Empty by default. At least one of title or content
6774
+ # should be set otherwise an INVALID_ARGUMENT error is thrown.
6775
+ # Corresponds to the JSON property `content`
6776
+ # @return [String]
6777
+ attr_accessor :content
6778
+
6779
+ # The unique ID to represent the record.
6780
+ # Corresponds to the JSON property `id`
6781
+ # @return [String]
6782
+ attr_accessor :id
6783
+
6784
+ # The score of this record based on the given query and selected model.
6785
+ # Corresponds to the JSON property `score`
6786
+ # @return [Float]
6787
+ attr_accessor :score
6788
+
6789
+ # The title of the record. Empty by default. At least one of title or content
6790
+ # should be set otherwise an INVALID_ARGUMENT error is thrown.
6791
+ # Corresponds to the JSON property `title`
6792
+ # @return [String]
6793
+ attr_accessor :title
6794
+
6795
+ def initialize(**args)
6796
+ update!(**args)
6797
+ end
6798
+
6799
+ # Update properties of this object
6800
+ def update!(**args)
6801
+ @content = args[:content] if args.key?(:content)
6802
+ @id = args[:id] if args.key?(:id)
6803
+ @score = args[:score] if args.key?(:score)
6804
+ @title = args[:title] if args.key?(:title)
6805
+ end
6806
+ end
6807
+
6254
6808
  # Request message for Recommend method.
6255
6809
  class GoogleCloudDiscoveryengineV1betaRecommendRequest
6256
6810
  include Google::Apis::Core::Hashable
@@ -6511,6 +7065,19 @@ module Google
6511
7065
  end
6512
7066
  end
6513
7067
 
7068
+ # Request for resuming training of an engine.
7069
+ class GoogleCloudDiscoveryengineV1betaResumeEngineRequest
7070
+ include Google::Apis::Core::Hashable
7071
+
7072
+ def initialize(**args)
7073
+ update!(**args)
7074
+ end
7075
+
7076
+ # Update properties of this object
7077
+ def update!(**args)
7078
+ end
7079
+ end
7080
+
6514
7081
  # Defines the structure and layout of a type of document data.
6515
7082
  class GoogleCloudDiscoveryengineV1betaSchema
6516
7083
  include Google::Apis::Core::Hashable
@@ -7827,6 +8394,11 @@ module Google
7827
8394
  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
7828
8395
  include Google::Apis::Core::Hashable
7829
8396
 
8397
+ # List of cited chunk contents derived from document content.
8398
+ # Corresponds to the JSON property `chunkContents`
8399
+ # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent>]
8400
+ attr_accessor :chunk_contents
8401
+
7830
8402
  # Required. Document.name of the document. Full resource name of the referenced
7831
8403
  # document, in the format `projects/*/locations/*/collections/*/dataStores/*/
7832
8404
  # branches/*/documents/*`.
@@ -7850,12 +8422,38 @@ module Google
7850
8422
 
7851
8423
  # Update properties of this object
7852
8424
  def update!(**args)
8425
+ @chunk_contents = args[:chunk_contents] if args.key?(:chunk_contents)
7853
8426
  @document = args[:document] if args.key?(:document)
7854
8427
  @title = args[:title] if args.key?(:title)
7855
8428
  @uri = args[:uri] if args.key?(:uri)
7856
8429
  end
7857
8430
  end
7858
8431
 
8432
+ # Chunk content.
8433
+ class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent
8434
+ include Google::Apis::Core::Hashable
8435
+
8436
+ # Chunk textual content.
8437
+ # Corresponds to the JSON property `content`
8438
+ # @return [String]
8439
+ attr_accessor :content
8440
+
8441
+ # Page identifier.
8442
+ # Corresponds to the JSON property `pageIdentifier`
8443
+ # @return [String]
8444
+ attr_accessor :page_identifier
8445
+
8446
+ def initialize(**args)
8447
+ update!(**args)
8448
+ end
8449
+
8450
+ # Update properties of this object
8451
+ def update!(**args)
8452
+ @content = args[:content] if args.key?(:content)
8453
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
8454
+ end
8455
+ end
8456
+
7859
8457
  # Safety Attribute categories and their associated confidence scores.
7860
8458
  class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes
7861
8459
  include Google::Apis::Core::Hashable
@@ -8216,6 +8814,53 @@ module Google
8216
8814
  end
8217
8815
  end
8218
8816
 
8817
+ # The Spanner source for importing data
8818
+ class GoogleCloudDiscoveryengineV1betaSpannerSource
8819
+ include Google::Apis::Core::Hashable
8820
+
8821
+ # Required. The database ID of the source Spanner table.
8822
+ # Corresponds to the JSON property `databaseId`
8823
+ # @return [String]
8824
+ attr_accessor :database_id
8825
+
8826
+ # Optional. Whether to apply data boost on Spanner export. Enabling this option
8827
+ # will incur additional cost. More info: https://cloud.google.com/spanner/docs/
8828
+ # databoost/databoost-overview#billing_and_quotas
8829
+ # Corresponds to the JSON property `enableDataBoost`
8830
+ # @return [Boolean]
8831
+ attr_accessor :enable_data_boost
8832
+ alias_method :enable_data_boost?, :enable_data_boost
8833
+
8834
+ # Required. The instance ID of the source Spanner table.
8835
+ # Corresponds to the JSON property `instanceId`
8836
+ # @return [String]
8837
+ attr_accessor :instance_id
8838
+
8839
+ # The project ID that the Spanner source is in with a length limit of 128
8840
+ # characters. If not specified, inherits the project ID from the parent request.
8841
+ # Corresponds to the JSON property `projectId`
8842
+ # @return [String]
8843
+ attr_accessor :project_id
8844
+
8845
+ # Required. The table name of the Spanner database that needs to be imported.
8846
+ # Corresponds to the JSON property `tableId`
8847
+ # @return [String]
8848
+ attr_accessor :table_id
8849
+
8850
+ def initialize(**args)
8851
+ update!(**args)
8852
+ end
8853
+
8854
+ # Update properties of this object
8855
+ def update!(**args)
8856
+ @database_id = args[:database_id] if args.key?(:database_id)
8857
+ @enable_data_boost = args[:enable_data_boost] if args.key?(:enable_data_boost)
8858
+ @instance_id = args[:instance_id] if args.key?(:instance_id)
8859
+ @project_id = args[:project_id] if args.key?(:project_id)
8860
+ @table_id = args[:table_id] if args.key?(:table_id)
8861
+ end
8862
+ end
8863
+
8219
8864
  # Suggestion deny list entry identifying the phrase to block from suggestions
8220
8865
  # and the applied operation for the phrase.
8221
8866
  class GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry
@@ -8509,6 +9154,11 @@ module Google
8509
9154
  # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
8510
9155
  attr_accessor :error_samples
8511
9156
 
9157
+ # The metrics of the trained model.
9158
+ # Corresponds to the JSON property `metrics`
9159
+ # @return [Hash<String,Float>]
9160
+ attr_accessor :metrics
9161
+
8512
9162
  # The trained model status. Possible values are: * **bad-data**: The training
8513
9163
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
8514
9164
  # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
@@ -8525,6 +9175,7 @@ module Google
8525
9175
  def update!(**args)
8526
9176
  @error_config = args[:error_config] if args.key?(:error_config)
8527
9177
  @error_samples = args[:error_samples] if args.key?(:error_samples)
9178
+ @metrics = args[:metrics] if args.key?(:metrics)
8528
9179
  @model_status = args[:model_status] if args.key?(:model_status)
8529
9180
  end
8530
9181
  end
@@ -8588,6 +9239,41 @@ module Google
8588
9239
  end
8589
9240
  end
8590
9241
 
9242
+ # Metadata associated with a tune operation.
9243
+ class GoogleCloudDiscoveryengineV1betaTuneEngineMetadata
9244
+ include Google::Apis::Core::Hashable
9245
+
9246
+ # Required. The resource name of the engine that this tune applies to. Format: `
9247
+ # projects/`project_number`/locations/`location_id`/collections/`collection_id`/
9248
+ # engines/`engine_id``
9249
+ # Corresponds to the JSON property `engine`
9250
+ # @return [String]
9251
+ attr_accessor :engine
9252
+
9253
+ def initialize(**args)
9254
+ update!(**args)
9255
+ end
9256
+
9257
+ # Update properties of this object
9258
+ def update!(**args)
9259
+ @engine = args[:engine] if args.key?(:engine)
9260
+ end
9261
+ end
9262
+
9263
+ # Request to manually start a tuning process now (instead of waiting for the
9264
+ # periodically scheduled tuning to happen).
9265
+ class GoogleCloudDiscoveryengineV1betaTuneEngineRequest
9266
+ include Google::Apis::Core::Hashable
9267
+
9268
+ def initialize(**args)
9269
+ update!(**args)
9270
+ end
9271
+
9272
+ # Update properties of this object
9273
+ def update!(**args)
9274
+ end
9275
+ end
9276
+
8591
9277
  # Metadata for UpdateSchema LRO.
8592
9278
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
8593
9279
  include Google::Apis::Core::Hashable