google-apis-discoveryengine_v1beta 0.28.0 → 0.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +532 -1
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +288 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +232 -2
- metadata +3 -3
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: ca4996aa7b870ac4084f6cbdd17150b0c4b63453ad3b985649ea5e7507eb52e9
         | 
| 4 | 
            +
              data.tar.gz: cbdd5499c6079ed6f0215c3d30882fdbc3752080e32cb40581ab613370b7769b
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: e78cda438a029b6cc8c61fa6adf13589246bdc63856ec812371b171b1e89a8e2c7b0a7b768823705d360d11ca576175911c7f433511cc038a30adc932ff46df1
         | 
| 7 | 
            +
              data.tar.gz: 43cd2f752b88a01254df8d4a9c4f8dad7b718bbaaaf429c80133e123ef3fe5d8800a41b29de7239424f6d9cb0120c62d21b1833258001e0632672aef203b210f
         | 
    
        data/CHANGELOG.md
    CHANGED
    
    | @@ -1,5 +1,13 @@ | |
| 1 1 | 
             
            # Release history for google-apis-discoveryengine_v1beta
         | 
| 2 2 |  | 
| 3 | 
            +
            ### v0.30.0 (2023-12-17)
         | 
| 4 | 
            +
             | 
| 5 | 
            +
            * Regenerated from discovery document revision 20231209
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            ### v0.29.0 (2023-12-10)
         | 
| 8 | 
            +
             | 
| 9 | 
            +
            * Regenerated from discovery document revision 20231130
         | 
| 10 | 
            +
             | 
| 3 11 | 
             
            ### v0.28.0 (2023-11-19)
         | 
| 4 12 |  | 
| 5 13 | 
             
            * Regenerated from discovery document revision 20231110
         | 
| @@ -622,6 +622,53 @@ module Google | |
| 622 622 | 
             
                    end
         | 
| 623 623 | 
             
                  end
         | 
| 624 624 |  | 
| 625 | 
            +
                  # Metadata related to the progress of the SiteSearchEngineService.
         | 
| 626 | 
            +
                  # BatchCreateTargetSite operation. This will be returned by the google.
         | 
| 627 | 
            +
                  # longrunning.Operation.metadata field.
         | 
| 628 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata
         | 
| 629 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 630 | 
            +
                  
         | 
| 631 | 
            +
                    # Operation create time.
         | 
| 632 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 633 | 
            +
                    # @return [String]
         | 
| 634 | 
            +
                    attr_accessor :create_time
         | 
| 635 | 
            +
                  
         | 
| 636 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 637 | 
            +
                    # time.
         | 
| 638 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 639 | 
            +
                    # @return [String]
         | 
| 640 | 
            +
                    attr_accessor :update_time
         | 
| 641 | 
            +
                  
         | 
| 642 | 
            +
                    def initialize(**args)
         | 
| 643 | 
            +
                       update!(**args)
         | 
| 644 | 
            +
                    end
         | 
| 645 | 
            +
                  
         | 
| 646 | 
            +
                    # Update properties of this object
         | 
| 647 | 
            +
                    def update!(**args)
         | 
| 648 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 649 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 650 | 
            +
                    end
         | 
| 651 | 
            +
                  end
         | 
| 652 | 
            +
                  
         | 
| 653 | 
            +
                  # Response message for SiteSearchEngineService.BatchCreateTargetSites method.
         | 
| 654 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
         | 
| 655 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 656 | 
            +
                  
         | 
| 657 | 
            +
                    # TargetSites created.
         | 
| 658 | 
            +
                    # Corresponds to the JSON property `targetSites`
         | 
| 659 | 
            +
                    # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite>]
         | 
| 660 | 
            +
                    attr_accessor :target_sites
         | 
| 661 | 
            +
                  
         | 
| 662 | 
            +
                    def initialize(**args)
         | 
| 663 | 
            +
                       update!(**args)
         | 
| 664 | 
            +
                    end
         | 
| 665 | 
            +
                  
         | 
| 666 | 
            +
                    # Update properties of this object
         | 
| 667 | 
            +
                    def update!(**args)
         | 
| 668 | 
            +
                      @target_sites = args[:target_sites] if args.key?(:target_sites)
         | 
| 669 | 
            +
                    end
         | 
| 670 | 
            +
                  end
         | 
| 671 | 
            +
                  
         | 
| 625 672 | 
             
                  # Metadata related to the progress of the DataStoreService.CreateDataStore
         | 
| 626 673 | 
             
                  # operation. This will be returned by the google.longrunning.Operation.metadata
         | 
| 627 674 | 
             
                  # field.
         | 
| @@ -703,6 +750,34 @@ module Google | |
| 703 750 | 
             
                    end
         | 
| 704 751 | 
             
                  end
         | 
| 705 752 |  | 
| 753 | 
            +
                  # Metadata related to the progress of the SiteSearchEngineService.
         | 
| 754 | 
            +
                  # CreateTargetSite operation. This will be returned by the google.longrunning.
         | 
| 755 | 
            +
                  # Operation.metadata field.
         | 
| 756 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata
         | 
| 757 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 758 | 
            +
                  
         | 
| 759 | 
            +
                    # Operation create time.
         | 
| 760 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 761 | 
            +
                    # @return [String]
         | 
| 762 | 
            +
                    attr_accessor :create_time
         | 
| 763 | 
            +
                  
         | 
| 764 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 765 | 
            +
                    # time.
         | 
| 766 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 767 | 
            +
                    # @return [String]
         | 
| 768 | 
            +
                    attr_accessor :update_time
         | 
| 769 | 
            +
                  
         | 
| 770 | 
            +
                    def initialize(**args)
         | 
| 771 | 
            +
                       update!(**args)
         | 
| 772 | 
            +
                    end
         | 
| 773 | 
            +
                  
         | 
| 774 | 
            +
                    # Update properties of this object
         | 
| 775 | 
            +
                    def update!(**args)
         | 
| 776 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 777 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 778 | 
            +
                    end
         | 
| 779 | 
            +
                  end
         | 
| 780 | 
            +
                  
         | 
| 706 781 | 
             
                  # DataStore captures global settings and configs at the DataStore level.
         | 
| 707 782 | 
             
                  class GoogleCloudDiscoveryengineV1alphaDataStore
         | 
| 708 783 | 
             
                    include Google::Apis::Core::Hashable
         | 
| @@ -848,6 +923,116 @@ module Google | |
| 848 923 | 
             
                    end
         | 
| 849 924 | 
             
                  end
         | 
| 850 925 |  | 
| 926 | 
            +
                  # Metadata related to the progress of the SiteSearchEngineService.
         | 
| 927 | 
            +
                  # DeleteTargetSite operation. This will be returned by the google.longrunning.
         | 
| 928 | 
            +
                  # Operation.metadata field.
         | 
| 929 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata
         | 
| 930 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 931 | 
            +
                  
         | 
| 932 | 
            +
                    # Operation create time.
         | 
| 933 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 934 | 
            +
                    # @return [String]
         | 
| 935 | 
            +
                    attr_accessor :create_time
         | 
| 936 | 
            +
                  
         | 
| 937 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 938 | 
            +
                    # time.
         | 
| 939 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 940 | 
            +
                    # @return [String]
         | 
| 941 | 
            +
                    attr_accessor :update_time
         | 
| 942 | 
            +
                  
         | 
| 943 | 
            +
                    def initialize(**args)
         | 
| 944 | 
            +
                       update!(**args)
         | 
| 945 | 
            +
                    end
         | 
| 946 | 
            +
                  
         | 
| 947 | 
            +
                    # Update properties of this object
         | 
| 948 | 
            +
                    def update!(**args)
         | 
| 949 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 950 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 951 | 
            +
                    end
         | 
| 952 | 
            +
                  end
         | 
| 953 | 
            +
                  
         | 
| 954 | 
            +
                  # Metadata related to the progress of the SiteSearchEngineService.
         | 
| 955 | 
            +
                  # DisableAdvancedSiteSearch operation. This will be returned by the google.
         | 
| 956 | 
            +
                  # longrunning.Operation.metadata field.
         | 
| 957 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata
         | 
| 958 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 959 | 
            +
                  
         | 
| 960 | 
            +
                    # Operation create time.
         | 
| 961 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 962 | 
            +
                    # @return [String]
         | 
| 963 | 
            +
                    attr_accessor :create_time
         | 
| 964 | 
            +
                  
         | 
| 965 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 966 | 
            +
                    # time.
         | 
| 967 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 968 | 
            +
                    # @return [String]
         | 
| 969 | 
            +
                    attr_accessor :update_time
         | 
| 970 | 
            +
                  
         | 
| 971 | 
            +
                    def initialize(**args)
         | 
| 972 | 
            +
                       update!(**args)
         | 
| 973 | 
            +
                    end
         | 
| 974 | 
            +
                  
         | 
| 975 | 
            +
                    # Update properties of this object
         | 
| 976 | 
            +
                    def update!(**args)
         | 
| 977 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 978 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 979 | 
            +
                    end
         | 
| 980 | 
            +
                  end
         | 
| 981 | 
            +
                  
         | 
| 982 | 
            +
                  # Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.
         | 
| 983 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse
         | 
| 984 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 985 | 
            +
                  
         | 
| 986 | 
            +
                    def initialize(**args)
         | 
| 987 | 
            +
                       update!(**args)
         | 
| 988 | 
            +
                    end
         | 
| 989 | 
            +
                  
         | 
| 990 | 
            +
                    # Update properties of this object
         | 
| 991 | 
            +
                    def update!(**args)
         | 
| 992 | 
            +
                    end
         | 
| 993 | 
            +
                  end
         | 
| 994 | 
            +
                  
         | 
| 995 | 
            +
                  # Metadata related to the progress of the SiteSearchEngineService.
         | 
| 996 | 
            +
                  # EnableAdvancedSiteSearch operation. This will be returned by the google.
         | 
| 997 | 
            +
                  # longrunning.Operation.metadata field.
         | 
| 998 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata
         | 
| 999 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 1000 | 
            +
                  
         | 
| 1001 | 
            +
                    # Operation create time.
         | 
| 1002 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 1003 | 
            +
                    # @return [String]
         | 
| 1004 | 
            +
                    attr_accessor :create_time
         | 
| 1005 | 
            +
                  
         | 
| 1006 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 1007 | 
            +
                    # time.
         | 
| 1008 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 1009 | 
            +
                    # @return [String]
         | 
| 1010 | 
            +
                    attr_accessor :update_time
         | 
| 1011 | 
            +
                  
         | 
| 1012 | 
            +
                    def initialize(**args)
         | 
| 1013 | 
            +
                       update!(**args)
         | 
| 1014 | 
            +
                    end
         | 
| 1015 | 
            +
                  
         | 
| 1016 | 
            +
                    # Update properties of this object
         | 
| 1017 | 
            +
                    def update!(**args)
         | 
| 1018 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 1019 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 1020 | 
            +
                    end
         | 
| 1021 | 
            +
                  end
         | 
| 1022 | 
            +
                  
         | 
| 1023 | 
            +
                  # Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.
         | 
| 1024 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse
         | 
| 1025 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 1026 | 
            +
                  
         | 
| 1027 | 
            +
                    def initialize(**args)
         | 
| 1028 | 
            +
                       update!(**args)
         | 
| 1029 | 
            +
                    end
         | 
| 1030 | 
            +
                  
         | 
| 1031 | 
            +
                    # Update properties of this object
         | 
| 1032 | 
            +
                    def update!(**args)
         | 
| 1033 | 
            +
                    end
         | 
| 1034 | 
            +
                  end
         | 
| 1035 | 
            +
                  
         | 
| 851 1036 | 
             
                  # Metadata that describes the training and serving parameters of an Engine.
         | 
| 852 1037 | 
             
                  class GoogleCloudDiscoveryengineV1alphaEngine
         | 
| 853 1038 | 
             
                    include Google::Apis::Core::Hashable
         | 
| @@ -1235,6 +1420,53 @@ module Google | |
| 1235 1420 | 
             
                    end
         | 
| 1236 1421 | 
             
                  end
         | 
| 1237 1422 |  | 
| 1423 | 
            +
                  # Metadata related to the progress of the EstimateDataSize operation. This is
         | 
| 1424 | 
            +
                  # returned by the google.longrunning.Operation.metadata field.
         | 
| 1425 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata
         | 
| 1426 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 1427 | 
            +
                  
         | 
| 1428 | 
            +
                    # Operation create time.
         | 
| 1429 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 1430 | 
            +
                    # @return [String]
         | 
| 1431 | 
            +
                    attr_accessor :create_time
         | 
| 1432 | 
            +
                  
         | 
| 1433 | 
            +
                    def initialize(**args)
         | 
| 1434 | 
            +
                       update!(**args)
         | 
| 1435 | 
            +
                    end
         | 
| 1436 | 
            +
                  
         | 
| 1437 | 
            +
                    # Update properties of this object
         | 
| 1438 | 
            +
                    def update!(**args)
         | 
| 1439 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 1440 | 
            +
                    end
         | 
| 1441 | 
            +
                  end
         | 
| 1442 | 
            +
                  
         | 
| 1443 | 
            +
                  # Response of the EstimateDataSize request. If the long running operation was
         | 
| 1444 | 
            +
                  # successful, then this message is returned by the google.longrunning.Operations.
         | 
| 1445 | 
            +
                  # response field if the operation was successful.
         | 
| 1446 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse
         | 
| 1447 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 1448 | 
            +
                  
         | 
| 1449 | 
            +
                    # Data size in terms of bytes.
         | 
| 1450 | 
            +
                    # Corresponds to the JSON property `dataSizeBytes`
         | 
| 1451 | 
            +
                    # @return [Fixnum]
         | 
| 1452 | 
            +
                    attr_accessor :data_size_bytes
         | 
| 1453 | 
            +
                  
         | 
| 1454 | 
            +
                    # Total number of documents.
         | 
| 1455 | 
            +
                    # Corresponds to the JSON property `documentCount`
         | 
| 1456 | 
            +
                    # @return [Fixnum]
         | 
| 1457 | 
            +
                    attr_accessor :document_count
         | 
| 1458 | 
            +
                  
         | 
| 1459 | 
            +
                    def initialize(**args)
         | 
| 1460 | 
            +
                       update!(**args)
         | 
| 1461 | 
            +
                    end
         | 
| 1462 | 
            +
                  
         | 
| 1463 | 
            +
                    # Update properties of this object
         | 
| 1464 | 
            +
                    def update!(**args)
         | 
| 1465 | 
            +
                      @data_size_bytes = args[:data_size_bytes] if args.key?(:data_size_bytes)
         | 
| 1466 | 
            +
                      @document_count = args[:document_count] if args.key?(:document_count)
         | 
| 1467 | 
            +
                    end
         | 
| 1468 | 
            +
                  end
         | 
| 1469 | 
            +
                  
         | 
| 1238 1470 | 
             
                  # Configurations for fields of a schema. For example, configuring a field is
         | 
| 1239 1471 | 
             
                  # indexable, or searchable.
         | 
| 1240 1472 | 
             
                  class GoogleCloudDiscoveryengineV1alphaFieldConfig
         | 
| @@ -1958,6 +2190,68 @@ module Google | |
| 1958 2190 | 
             
                    end
         | 
| 1959 2191 | 
             
                  end
         | 
| 1960 2192 |  | 
| 2193 | 
            +
                  # Metadata related to the progress of the TrainCustomModel operation. This is
         | 
| 2194 | 
            +
                  # returned by the google.longrunning.Operation.metadata field.
         | 
| 2195 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata
         | 
| 2196 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 2197 | 
            +
                  
         | 
| 2198 | 
            +
                    # Operation create time.
         | 
| 2199 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 2200 | 
            +
                    # @return [String]
         | 
| 2201 | 
            +
                    attr_accessor :create_time
         | 
| 2202 | 
            +
                  
         | 
| 2203 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 2204 | 
            +
                    # time.
         | 
| 2205 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 2206 | 
            +
                    # @return [String]
         | 
| 2207 | 
            +
                    attr_accessor :update_time
         | 
| 2208 | 
            +
                  
         | 
| 2209 | 
            +
                    def initialize(**args)
         | 
| 2210 | 
            +
                       update!(**args)
         | 
| 2211 | 
            +
                    end
         | 
| 2212 | 
            +
                  
         | 
| 2213 | 
            +
                    # Update properties of this object
         | 
| 2214 | 
            +
                    def update!(**args)
         | 
| 2215 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 2216 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 2217 | 
            +
                    end
         | 
| 2218 | 
            +
                  end
         | 
| 2219 | 
            +
                  
         | 
| 2220 | 
            +
                  # Response of the TrainCustomModelRequest. This message is returned by the
         | 
| 2221 | 
            +
                  # google.longrunning.Operations.response field.
         | 
| 2222 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse
         | 
| 2223 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 2224 | 
            +
                  
         | 
| 2225 | 
            +
                    # Configuration of destination for Import related errors.
         | 
| 2226 | 
            +
                    # Corresponds to the JSON property `errorConfig`
         | 
| 2227 | 
            +
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaImportErrorConfig]
         | 
| 2228 | 
            +
                    attr_accessor :error_config
         | 
| 2229 | 
            +
                  
         | 
| 2230 | 
            +
                    # A sample of errors encountered while processing the data.
         | 
| 2231 | 
            +
                    # Corresponds to the JSON property `errorSamples`
         | 
| 2232 | 
            +
                    # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleRpcStatus>]
         | 
| 2233 | 
            +
                    attr_accessor :error_samples
         | 
| 2234 | 
            +
                  
         | 
| 2235 | 
            +
                    # The trained model status. Possible values are: * **bad-data**: The training
         | 
| 2236 | 
            +
                    # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
         | 
| 2237 | 
            +
                    # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
         | 
| 2238 | 
            +
                    # The model is ready for serving.
         | 
| 2239 | 
            +
                    # Corresponds to the JSON property `modelStatus`
         | 
| 2240 | 
            +
                    # @return [String]
         | 
| 2241 | 
            +
                    attr_accessor :model_status
         | 
| 2242 | 
            +
                  
         | 
| 2243 | 
            +
                    def initialize(**args)
         | 
| 2244 | 
            +
                       update!(**args)
         | 
| 2245 | 
            +
                    end
         | 
| 2246 | 
            +
                  
         | 
| 2247 | 
            +
                    # Update properties of this object
         | 
| 2248 | 
            +
                    def update!(**args)
         | 
| 2249 | 
            +
                      @error_config = args[:error_config] if args.key?(:error_config)
         | 
| 2250 | 
            +
                      @error_samples = args[:error_samples] if args.key?(:error_samples)
         | 
| 2251 | 
            +
                      @model_status = args[:model_status] if args.key?(:model_status)
         | 
| 2252 | 
            +
                    end
         | 
| 2253 | 
            +
                  end
         | 
| 2254 | 
            +
                  
         | 
| 1961 2255 | 
             
                  # Metadata associated with a tune operation.
         | 
| 1962 2256 | 
             
                  class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
         | 
| 1963 2257 | 
             
                    include Google::Apis::Core::Hashable
         | 
| @@ -2018,6 +2312,34 @@ module Google | |
| 2018 2312 | 
             
                    end
         | 
| 2019 2313 | 
             
                  end
         | 
| 2020 2314 |  | 
| 2315 | 
            +
                  # Metadata related to the progress of the SiteSearchEngineService.
         | 
| 2316 | 
            +
                  # UpdateTargetSite operation. This will be returned by the google.longrunning.
         | 
| 2317 | 
            +
                  # Operation.metadata field.
         | 
| 2318 | 
            +
                  class GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata
         | 
| 2319 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 2320 | 
            +
                  
         | 
| 2321 | 
            +
                    # Operation create time.
         | 
| 2322 | 
            +
                    # Corresponds to the JSON property `createTime`
         | 
| 2323 | 
            +
                    # @return [String]
         | 
| 2324 | 
            +
                    attr_accessor :create_time
         | 
| 2325 | 
            +
                  
         | 
| 2326 | 
            +
                    # Operation last update time. If the operation is done, this is also the finish
         | 
| 2327 | 
            +
                    # time.
         | 
| 2328 | 
            +
                    # Corresponds to the JSON property `updateTime`
         | 
| 2329 | 
            +
                    # @return [String]
         | 
| 2330 | 
            +
                    attr_accessor :update_time
         | 
| 2331 | 
            +
                  
         | 
| 2332 | 
            +
                    def initialize(**args)
         | 
| 2333 | 
            +
                       update!(**args)
         | 
| 2334 | 
            +
                    end
         | 
| 2335 | 
            +
                  
         | 
| 2336 | 
            +
                    # Update properties of this object
         | 
| 2337 | 
            +
                    def update!(**args)
         | 
| 2338 | 
            +
                      @create_time = args[:create_time] if args.key?(:create_time)
         | 
| 2339 | 
            +
                      @update_time = args[:update_time] if args.key?(:update_time)
         | 
| 2340 | 
            +
                    end
         | 
| 2341 | 
            +
                  end
         | 
| 2342 | 
            +
                  
         | 
| 2021 2343 | 
             
                  # BigQuery source import data from.
         | 
| 2022 2344 | 
             
                  class GoogleCloudDiscoveryengineV1betaBigQuerySource
         | 
| 2023 2345 | 
             
                    include Google::Apis::Core::Hashable
         | 
| @@ -2184,7 +2506,8 @@ module Google | |
| 2184 2506 | 
             
                    attr_accessor :messages
         | 
| 2185 2507 |  | 
| 2186 2508 | 
             
                    # Immutable. Fully qualified name `project/*/locations/global/collections/`
         | 
| 2187 | 
            -
                    # collection`/dataStore/*/conversations/*`
         | 
| 2509 | 
            +
                    # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
         | 
| 2510 | 
            +
                    # collections/`collection`/engines/*/conversations/*`.
         | 
| 2188 2511 | 
             
                    # Corresponds to the JSON property `name`
         | 
| 2189 2512 | 
             
                    # @return [String]
         | 
| 2190 2513 | 
             
                    attr_accessor :name
         | 
| @@ -2286,6 +2609,22 @@ module Google | |
| 2286 2609 | 
             
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaConversation]
         | 
| 2287 2610 | 
             
                    attr_accessor :conversation
         | 
| 2288 2611 |  | 
| 2612 | 
            +
                    # The filter syntax consists of an expression language for constructing a
         | 
| 2613 | 
            +
                    # predicate from one or more fields of the documents being filtered. Filter
         | 
| 2614 | 
            +
                    # expression is case-sensitive. This will be used to filter search results which
         | 
| 2615 | 
            +
                    # may affect the summary response. If this field is unrecognizable, an `
         | 
| 2616 | 
            +
                    # INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
         | 
| 2617 | 
            +
                    # mapping the LHS filter key to a key property defined in the Vertex AI Search
         | 
| 2618 | 
            +
                    # backend -- this mapping is defined by the customer in their schema. For
         | 
| 2619 | 
            +
                    # example a media customer might have a field 'name' in their schema. In this
         | 
| 2620 | 
            +
                    # case the filter would look like this: filter --> name:'ANY("king kong")' For
         | 
| 2621 | 
            +
                    # more information about filtering including syntax and filter operators, see [
         | 
| 2622 | 
            +
                    # Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
         | 
| 2623 | 
            +
                    # metadata)
         | 
| 2624 | 
            +
                    # Corresponds to the JSON property `filter`
         | 
| 2625 | 
            +
                    # @return [String]
         | 
| 2626 | 
            +
                    attr_accessor :filter
         | 
| 2627 | 
            +
                  
         | 
| 2289 2628 | 
             
                    # Defines text input.
         | 
| 2290 2629 | 
             
                    # Corresponds to the JSON property `query`
         | 
| 2291 2630 | 
             
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaTextInput]
         | 
| @@ -2332,6 +2671,7 @@ module Google | |
| 2332 2671 | 
             
                    # Update properties of this object
         | 
| 2333 2672 | 
             
                    def update!(**args)
         | 
| 2334 2673 | 
             
                      @conversation = args[:conversation] if args.key?(:conversation)
         | 
| 2674 | 
            +
                      @filter = args[:filter] if args.key?(:filter)
         | 
| 2335 2675 | 
             
                      @query = args[:query] if args.key?(:query)
         | 
| 2336 2676 | 
             
                      @safe_search = args[:safe_search] if args.key?(:safe_search)
         | 
| 2337 2677 | 
             
                      @serving_config = args[:serving_config] if args.key?(:serving_config)
         | 
| @@ -4095,6 +4435,16 @@ module Google | |
| 4095 4435 | 
             
                    # @return [String]
         | 
| 4096 4436 | 
             
                    attr_accessor :language_code
         | 
| 4097 4437 |  | 
| 4438 | 
            +
                    # Specification of the prompt to use with the model.
         | 
| 4439 | 
            +
                    # Corresponds to the JSON property `modelPromptSpec`
         | 
| 4440 | 
            +
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec]
         | 
| 4441 | 
            +
                    attr_accessor :model_prompt_spec
         | 
| 4442 | 
            +
                  
         | 
| 4443 | 
            +
                    # Specification of the model.
         | 
| 4444 | 
            +
                    # Corresponds to the JSON property `modelSpec`
         | 
| 4445 | 
            +
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec]
         | 
| 4446 | 
            +
                    attr_accessor :model_spec
         | 
| 4447 | 
            +
                  
         | 
| 4098 4448 | 
             
                    # The number of top results to generate the summary from. If the number of
         | 
| 4099 4449 | 
             
                    # results returned is less than `summaryResultCount`, the summary is generated
         | 
| 4100 4450 | 
             
                    # from all of the results. At most five results can be used to generate a
         | 
| @@ -4113,10 +4463,51 @@ module Google | |
| 4113 4463 | 
             
                      @ignore_non_summary_seeking_query = args[:ignore_non_summary_seeking_query] if args.key?(:ignore_non_summary_seeking_query)
         | 
| 4114 4464 | 
             
                      @include_citations = args[:include_citations] if args.key?(:include_citations)
         | 
| 4115 4465 | 
             
                      @language_code = args[:language_code] if args.key?(:language_code)
         | 
| 4466 | 
            +
                      @model_prompt_spec = args[:model_prompt_spec] if args.key?(:model_prompt_spec)
         | 
| 4467 | 
            +
                      @model_spec = args[:model_spec] if args.key?(:model_spec)
         | 
| 4116 4468 | 
             
                      @summary_result_count = args[:summary_result_count] if args.key?(:summary_result_count)
         | 
| 4117 4469 | 
             
                    end
         | 
| 4118 4470 | 
             
                  end
         | 
| 4119 4471 |  | 
| 4472 | 
            +
                  # Specification of the prompt to use with the model.
         | 
| 4473 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec
         | 
| 4474 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 4475 | 
            +
                  
         | 
| 4476 | 
            +
                    # Text at the beginning of the prompt that instructs the assistant. Examples are
         | 
| 4477 | 
            +
                    # available in the user guide.
         | 
| 4478 | 
            +
                    # Corresponds to the JSON property `preamble`
         | 
| 4479 | 
            +
                    # @return [String]
         | 
| 4480 | 
            +
                    attr_accessor :preamble
         | 
| 4481 | 
            +
                  
         | 
| 4482 | 
            +
                    def initialize(**args)
         | 
| 4483 | 
            +
                       update!(**args)
         | 
| 4484 | 
            +
                    end
         | 
| 4485 | 
            +
                  
         | 
| 4486 | 
            +
                    # Update properties of this object
         | 
| 4487 | 
            +
                    def update!(**args)
         | 
| 4488 | 
            +
                      @preamble = args[:preamble] if args.key?(:preamble)
         | 
| 4489 | 
            +
                    end
         | 
| 4490 | 
            +
                  end
         | 
| 4491 | 
            +
                  
         | 
| 4492 | 
            +
                  # Specification of the model.
         | 
| 4493 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec
         | 
| 4494 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 4495 | 
            +
                  
         | 
| 4496 | 
            +
                    # The string format of the model version. e.g. stable, preview, etc.
         | 
| 4497 | 
            +
                    # Corresponds to the JSON property `version`
         | 
| 4498 | 
            +
                    # @return [String]
         | 
| 4499 | 
            +
                    attr_accessor :version
         | 
| 4500 | 
            +
                  
         | 
| 4501 | 
            +
                    def initialize(**args)
         | 
| 4502 | 
            +
                       update!(**args)
         | 
| 4503 | 
            +
                    end
         | 
| 4504 | 
            +
                  
         | 
| 4505 | 
            +
                    # Update properties of this object
         | 
| 4506 | 
            +
                    def update!(**args)
         | 
| 4507 | 
            +
                      @version = args[:version] if args.key?(:version)
         | 
| 4508 | 
            +
                    end
         | 
| 4509 | 
            +
                  end
         | 
| 4510 | 
            +
                  
         | 
| 4120 4511 | 
             
                  # The specification that uses customized query embedding vector to do semantic
         | 
| 4121 4512 | 
             
                  # document retrieval.
         | 
| 4122 4513 | 
             
                  class GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec
         | 
| @@ -4694,6 +5085,11 @@ module Google | |
| 4694 5085 | 
             
                    # @return [String]
         | 
| 4695 5086 | 
             
                    attr_accessor :summary_text
         | 
| 4696 5087 |  | 
| 5088 | 
            +
                    # Summary with metadata information.
         | 
| 5089 | 
            +
                    # Corresponds to the JSON property `summaryWithMetadata`
         | 
| 5090 | 
            +
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata]
         | 
| 5091 | 
            +
                    attr_accessor :summary_with_metadata
         | 
| 5092 | 
            +
                  
         | 
| 4697 5093 | 
             
                    def initialize(**args)
         | 
| 4698 5094 | 
             
                       update!(**args)
         | 
| 4699 5095 | 
             
                    end
         | 
| @@ -4703,6 +5099,110 @@ module Google | |
| 4703 5099 | 
             
                      @safety_attributes = args[:safety_attributes] if args.key?(:safety_attributes)
         | 
| 4704 5100 | 
             
                      @summary_skipped_reasons = args[:summary_skipped_reasons] if args.key?(:summary_skipped_reasons)
         | 
| 4705 5101 | 
             
                      @summary_text = args[:summary_text] if args.key?(:summary_text)
         | 
| 5102 | 
            +
                      @summary_with_metadata = args[:summary_with_metadata] if args.key?(:summary_with_metadata)
         | 
| 5103 | 
            +
                    end
         | 
| 5104 | 
            +
                  end
         | 
| 5105 | 
            +
                  
         | 
| 5106 | 
            +
                  # Citation info for a segment.
         | 
| 5107 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation
         | 
| 5108 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 5109 | 
            +
                  
         | 
| 5110 | 
            +
                    # End of the attributed segment, exclusive.
         | 
| 5111 | 
            +
                    # Corresponds to the JSON property `endIndex`
         | 
| 5112 | 
            +
                    # @return [Fixnum]
         | 
| 5113 | 
            +
                    attr_accessor :end_index
         | 
| 5114 | 
            +
                  
         | 
| 5115 | 
            +
                    # Citation sources for the attributed segment.
         | 
| 5116 | 
            +
                    # Corresponds to the JSON property `sources`
         | 
| 5117 | 
            +
                    # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource>]
         | 
| 5118 | 
            +
                    attr_accessor :sources
         | 
| 5119 | 
            +
                  
         | 
| 5120 | 
            +
                    # Index indicates the start of the segment, measured in bytes/unicode.
         | 
| 5121 | 
            +
                    # Corresponds to the JSON property `startIndex`
         | 
| 5122 | 
            +
                    # @return [Fixnum]
         | 
| 5123 | 
            +
                    attr_accessor :start_index
         | 
| 5124 | 
            +
                  
         | 
| 5125 | 
            +
                    def initialize(**args)
         | 
| 5126 | 
            +
                       update!(**args)
         | 
| 5127 | 
            +
                    end
         | 
| 5128 | 
            +
                  
         | 
| 5129 | 
            +
                    # Update properties of this object
         | 
| 5130 | 
            +
                    def update!(**args)
         | 
| 5131 | 
            +
                      @end_index = args[:end_index] if args.key?(:end_index)
         | 
| 5132 | 
            +
                      @sources = args[:sources] if args.key?(:sources)
         | 
| 5133 | 
            +
                      @start_index = args[:start_index] if args.key?(:start_index)
         | 
| 5134 | 
            +
                    end
         | 
| 5135 | 
            +
                  end
         | 
| 5136 | 
            +
                  
         | 
| 5137 | 
            +
                  # Citation metadata.
         | 
| 5138 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata
         | 
| 5139 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 5140 | 
            +
                  
         | 
| 5141 | 
            +
                    # Citations for segments.
         | 
| 5142 | 
            +
                    # Corresponds to the JSON property `citations`
         | 
| 5143 | 
            +
                    # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation>]
         | 
| 5144 | 
            +
                    attr_accessor :citations
         | 
| 5145 | 
            +
                  
         | 
| 5146 | 
            +
                    def initialize(**args)
         | 
| 5147 | 
            +
                       update!(**args)
         | 
| 5148 | 
            +
                    end
         | 
| 5149 | 
            +
                  
         | 
| 5150 | 
            +
                    # Update properties of this object
         | 
| 5151 | 
            +
                    def update!(**args)
         | 
| 5152 | 
            +
                      @citations = args[:citations] if args.key?(:citations)
         | 
| 5153 | 
            +
                    end
         | 
| 5154 | 
            +
                  end
         | 
| 5155 | 
            +
                  
         | 
| 5156 | 
            +
                  # Citation source.
         | 
| 5157 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource
         | 
| 5158 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 5159 | 
            +
                  
         | 
| 5160 | 
            +
                    # Document reference index from SummaryWithMetadata.references. It is 0-indexed
         | 
| 5161 | 
            +
                    # and the value will be zero if the reference_index is not set explicitly.
         | 
| 5162 | 
            +
                    # Corresponds to the JSON property `referenceIndex`
         | 
| 5163 | 
            +
                    # @return [Fixnum]
         | 
| 5164 | 
            +
                    attr_accessor :reference_index
         | 
| 5165 | 
            +
                  
         | 
| 5166 | 
            +
                    def initialize(**args)
         | 
| 5167 | 
            +
                       update!(**args)
         | 
| 5168 | 
            +
                    end
         | 
| 5169 | 
            +
                  
         | 
| 5170 | 
            +
                    # Update properties of this object
         | 
| 5171 | 
            +
                    def update!(**args)
         | 
| 5172 | 
            +
                      @reference_index = args[:reference_index] if args.key?(:reference_index)
         | 
| 5173 | 
            +
                    end
         | 
| 5174 | 
            +
                  end
         | 
| 5175 | 
            +
                  
         | 
| 5176 | 
            +
                  # Document reference.
         | 
| 5177 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference
         | 
| 5178 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 5179 | 
            +
                  
         | 
| 5180 | 
            +
                    # Required. Document.name of the document. Full resource name of the referenced
         | 
| 5181 | 
            +
                    # document, in the format `projects/*/locations/*/collections/*/dataStores/*/
         | 
| 5182 | 
            +
                    # branches/*/documents/*`.
         | 
| 5183 | 
            +
                    # Corresponds to the JSON property `document`
         | 
| 5184 | 
            +
                    # @return [String]
         | 
| 5185 | 
            +
                    attr_accessor :document
         | 
| 5186 | 
            +
                  
         | 
| 5187 | 
            +
                    # Title of the document.
         | 
| 5188 | 
            +
                    # Corresponds to the JSON property `title`
         | 
| 5189 | 
            +
                    # @return [String]
         | 
| 5190 | 
            +
                    attr_accessor :title
         | 
| 5191 | 
            +
                  
         | 
| 5192 | 
            +
                    # GCS or HTTP uri for the document.
         | 
| 5193 | 
            +
                    # Corresponds to the JSON property `uri`
         | 
| 5194 | 
            +
                    # @return [String]
         | 
| 5195 | 
            +
                    attr_accessor :uri
         | 
| 5196 | 
            +
                  
         | 
| 5197 | 
            +
                    def initialize(**args)
         | 
| 5198 | 
            +
                       update!(**args)
         | 
| 5199 | 
            +
                    end
         | 
| 5200 | 
            +
                  
         | 
| 5201 | 
            +
                    # Update properties of this object
         | 
| 5202 | 
            +
                    def update!(**args)
         | 
| 5203 | 
            +
                      @document = args[:document] if args.key?(:document)
         | 
| 5204 | 
            +
                      @title = args[:title] if args.key?(:title)
         | 
| 5205 | 
            +
                      @uri = args[:uri] if args.key?(:uri)
         | 
| 4706 5206 | 
             
                    end
         | 
| 4707 5207 | 
             
                  end
         | 
| 4708 5208 |  | 
| @@ -4733,6 +5233,37 @@ module Google | |
| 4733 5233 | 
             
                    end
         | 
| 4734 5234 | 
             
                  end
         | 
| 4735 5235 |  | 
| 5236 | 
            +
                  # Summary with metadata information.
         | 
| 5237 | 
            +
                  class GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata
         | 
| 5238 | 
            +
                    include Google::Apis::Core::Hashable
         | 
| 5239 | 
            +
                  
         | 
| 5240 | 
            +
                    # Citation metadata.
         | 
| 5241 | 
            +
                    # Corresponds to the JSON property `citationMetadata`
         | 
| 5242 | 
            +
                    # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata]
         | 
| 5243 | 
            +
                    attr_accessor :citation_metadata
         | 
| 5244 | 
            +
                  
         | 
| 5245 | 
            +
                    # Document References.
         | 
| 5246 | 
            +
                    # Corresponds to the JSON property `references`
         | 
| 5247 | 
            +
                    # @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference>]
         | 
| 5248 | 
            +
                    attr_accessor :references
         | 
| 5249 | 
            +
                  
         | 
| 5250 | 
            +
                    # Summary text with no citation information.
         | 
| 5251 | 
            +
                    # Corresponds to the JSON property `summary`
         | 
| 5252 | 
            +
                    # @return [String]
         | 
| 5253 | 
            +
                    attr_accessor :summary
         | 
| 5254 | 
            +
                  
         | 
| 5255 | 
            +
                    def initialize(**args)
         | 
| 5256 | 
            +
                       update!(**args)
         | 
| 5257 | 
            +
                    end
         | 
| 5258 | 
            +
                  
         | 
| 5259 | 
            +
                    # Update properties of this object
         | 
| 5260 | 
            +
                    def update!(**args)
         | 
| 5261 | 
            +
                      @citation_metadata = args[:citation_metadata] if args.key?(:citation_metadata)
         | 
| 5262 | 
            +
                      @references = args[:references] if args.key?(:references)
         | 
| 5263 | 
            +
                      @summary = args[:summary] if args.key?(:summary)
         | 
| 5264 | 
            +
                    end
         | 
| 5265 | 
            +
                  end
         | 
| 5266 | 
            +
                  
         | 
| 4736 5267 | 
             
                  # Defines text input.
         | 
| 4737 5268 | 
             
                  class GoogleCloudDiscoveryengineV1betaTextInput
         | 
| 4738 5269 | 
             
                    include Google::Apis::Core::Hashable
         | 
| @@ -16,13 +16,13 @@ module Google | |
| 16 16 | 
             
              module Apis
         | 
| 17 17 | 
             
                module DiscoveryengineV1beta
         | 
| 18 18 | 
             
                  # Version of the google-apis-discoveryengine_v1beta gem
         | 
| 19 | 
            -
                  GEM_VERSION = "0. | 
| 19 | 
            +
                  GEM_VERSION = "0.30.0"
         | 
| 20 20 |  | 
| 21 21 | 
             
                  # Version of the code generator used to generate this client
         | 
| 22 22 | 
             
                  GENERATOR_VERSION = "0.12.0"
         | 
| 23 23 |  | 
| 24 24 | 
             
                  # Revision of the discovery document this client was generated from
         | 
| 25 | 
            -
                  REVISION = " | 
| 25 | 
            +
                  REVISION = "20231209"
         | 
| 26 26 | 
             
                end
         | 
| 27 27 | 
             
              end
         | 
| 28 28 | 
             
            end
         |