google-apis-discoveryengine_v1beta 0.26.0 → 0.28.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +608 -0
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +263 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +110 -21
- 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: 8a3a7f905a2cf4a974dba5d83c9aca64a5401ecc1748c9c9573ba62e581bbcbf
|
4
|
+
data.tar.gz: 5efd43e1df5a8f74727fd533a1a8c8f9f206054849e934bcd958063ef2ec9ec4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d8df7bc261909195ca8ee25290dd3c39e73a6e405657d950021511206c4e73120c3c41048a43153ebd4ccd7b5fda495e1691b9f1dcb8a10c1d522327e1ef806c
|
7
|
+
data.tar.gz: 11134bf7d0c095eeb7370831e78c2636ac387a6e62015f3b92c5061a21ef980e72d477d7866eae0e0b651cddad4a251b2f3861ac0e35cc17281cc64d4e4c126c
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1beta
|
2
2
|
|
3
|
+
### v0.28.0 (2023-11-19)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20231110
|
6
|
+
|
7
|
+
### v0.27.0 (2023-11-12)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20231102
|
10
|
+
|
3
11
|
### v0.26.0 (2023-11-05)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20231026
|
@@ -622,6 +622,61 @@ module Google
|
|
622
622
|
end
|
623
623
|
end
|
624
624
|
|
625
|
+
# Metadata related to the progress of the DataStoreService.CreateDataStore
|
626
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
627
|
+
# field.
|
628
|
+
class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
|
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
|
+
# Metadata related to the progress of the EngineService.CreateEngine operation.
|
654
|
+
# This will be returned by the google.longrunning.Operation.metadata field.
|
655
|
+
class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
|
656
|
+
include Google::Apis::Core::Hashable
|
657
|
+
|
658
|
+
# Operation create time.
|
659
|
+
# Corresponds to the JSON property `createTime`
|
660
|
+
# @return [String]
|
661
|
+
attr_accessor :create_time
|
662
|
+
|
663
|
+
# Operation last update time. If the operation is done, this is also the finish
|
664
|
+
# time.
|
665
|
+
# Corresponds to the JSON property `updateTime`
|
666
|
+
# @return [String]
|
667
|
+
attr_accessor :update_time
|
668
|
+
|
669
|
+
def initialize(**args)
|
670
|
+
update!(**args)
|
671
|
+
end
|
672
|
+
|
673
|
+
# Update properties of this object
|
674
|
+
def update!(**args)
|
675
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
676
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
677
|
+
end
|
678
|
+
end
|
679
|
+
|
625
680
|
# Metadata for Create Schema LRO.
|
626
681
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
627
682
|
include Google::Apis::Core::Hashable
|
@@ -648,6 +703,125 @@ module Google
|
|
648
703
|
end
|
649
704
|
end
|
650
705
|
|
706
|
+
# DataStore captures global settings and configs at the DataStore level.
|
707
|
+
class GoogleCloudDiscoveryengineV1alphaDataStore
|
708
|
+
include Google::Apis::Core::Hashable
|
709
|
+
|
710
|
+
# Immutable. The content config of the data store. If this field is unset, the
|
711
|
+
# server behavior defaults to ContentConfig.NO_CONTENT.
|
712
|
+
# Corresponds to the JSON property `contentConfig`
|
713
|
+
# @return [String]
|
714
|
+
attr_accessor :content_config
|
715
|
+
|
716
|
+
# Output only. Timestamp the DataStore was created at.
|
717
|
+
# Corresponds to the JSON property `createTime`
|
718
|
+
# @return [String]
|
719
|
+
attr_accessor :create_time
|
720
|
+
|
721
|
+
# Output only. The id of the default Schema asscociated to this data store.
|
722
|
+
# Corresponds to the JSON property `defaultSchemaId`
|
723
|
+
# @return [String]
|
724
|
+
attr_accessor :default_schema_id
|
725
|
+
|
726
|
+
# Required. The data store display name. This field must be a UTF-8 encoded
|
727
|
+
# string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
|
728
|
+
# error is returned.
|
729
|
+
# Corresponds to the JSON property `displayName`
|
730
|
+
# @return [String]
|
731
|
+
attr_accessor :display_name
|
732
|
+
|
733
|
+
# Immutable. The industry vertical that the data store registers.
|
734
|
+
# Corresponds to the JSON property `industryVertical`
|
735
|
+
# @return [String]
|
736
|
+
attr_accessor :industry_vertical
|
737
|
+
|
738
|
+
# Immutable. The full resource name of the data store. Format: `projects/`
|
739
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
740
|
+
# data_store_id``. This field must be a UTF-8 encoded string with a length limit
|
741
|
+
# of 1024 characters.
|
742
|
+
# Corresponds to the JSON property `name`
|
743
|
+
# @return [String]
|
744
|
+
attr_accessor :name
|
745
|
+
|
746
|
+
# The solutions that the data store enrolls. Available solutions for each
|
747
|
+
# industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `
|
748
|
+
# SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is
|
749
|
+
# automatically enrolled. Other solutions cannot be enrolled.
|
750
|
+
# Corresponds to the JSON property `solutionTypes`
|
751
|
+
# @return [Array<String>]
|
752
|
+
attr_accessor :solution_types
|
753
|
+
|
754
|
+
def initialize(**args)
|
755
|
+
update!(**args)
|
756
|
+
end
|
757
|
+
|
758
|
+
# Update properties of this object
|
759
|
+
def update!(**args)
|
760
|
+
@content_config = args[:content_config] if args.key?(:content_config)
|
761
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
762
|
+
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
763
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
764
|
+
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
765
|
+
@name = args[:name] if args.key?(:name)
|
766
|
+
@solution_types = args[:solution_types] if args.key?(:solution_types)
|
767
|
+
end
|
768
|
+
end
|
769
|
+
|
770
|
+
# Metadata related to the progress of the DataStoreService.DeleteDataStore
|
771
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
772
|
+
# field.
|
773
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
|
774
|
+
include Google::Apis::Core::Hashable
|
775
|
+
|
776
|
+
# Operation create time.
|
777
|
+
# Corresponds to the JSON property `createTime`
|
778
|
+
# @return [String]
|
779
|
+
attr_accessor :create_time
|
780
|
+
|
781
|
+
# Operation last update time. If the operation is done, this is also the finish
|
782
|
+
# time.
|
783
|
+
# Corresponds to the JSON property `updateTime`
|
784
|
+
# @return [String]
|
785
|
+
attr_accessor :update_time
|
786
|
+
|
787
|
+
def initialize(**args)
|
788
|
+
update!(**args)
|
789
|
+
end
|
790
|
+
|
791
|
+
# Update properties of this object
|
792
|
+
def update!(**args)
|
793
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
794
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
795
|
+
end
|
796
|
+
end
|
797
|
+
|
798
|
+
# Metadata related to the progress of the EngineService.DeleteEngine operation.
|
799
|
+
# This will be returned by the google.longrunning.Operation.metadata field.
|
800
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
|
801
|
+
include Google::Apis::Core::Hashable
|
802
|
+
|
803
|
+
# Operation create time.
|
804
|
+
# Corresponds to the JSON property `createTime`
|
805
|
+
# @return [String]
|
806
|
+
attr_accessor :create_time
|
807
|
+
|
808
|
+
# Operation last update time. If the operation is done, this is also the finish
|
809
|
+
# time.
|
810
|
+
# Corresponds to the JSON property `updateTime`
|
811
|
+
# @return [String]
|
812
|
+
attr_accessor :update_time
|
813
|
+
|
814
|
+
def initialize(**args)
|
815
|
+
update!(**args)
|
816
|
+
end
|
817
|
+
|
818
|
+
# Update properties of this object
|
819
|
+
def update!(**args)
|
820
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
821
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
822
|
+
end
|
823
|
+
end
|
824
|
+
|
651
825
|
# Metadata for DeleteSchema LRO.
|
652
826
|
class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
|
653
827
|
include Google::Apis::Core::Hashable
|
@@ -674,6 +848,393 @@ module Google
|
|
674
848
|
end
|
675
849
|
end
|
676
850
|
|
851
|
+
# Metadata that describes the training and serving parameters of an Engine.
|
852
|
+
class GoogleCloudDiscoveryengineV1alphaEngine
|
853
|
+
include Google::Apis::Core::Hashable
|
854
|
+
|
855
|
+
# Configurations for a Chat Engine.
|
856
|
+
# Corresponds to the JSON property `chatEngineConfig`
|
857
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
|
858
|
+
attr_accessor :chat_engine_config
|
859
|
+
|
860
|
+
# Additional information of a Chat Engine. Fields in this message are output
|
861
|
+
# only.
|
862
|
+
# Corresponds to the JSON property `chatEngineMetadata`
|
863
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata]
|
864
|
+
attr_accessor :chat_engine_metadata
|
865
|
+
|
866
|
+
# Common configurations for an Engine.
|
867
|
+
# Corresponds to the JSON property `commonConfig`
|
868
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig]
|
869
|
+
attr_accessor :common_config
|
870
|
+
|
871
|
+
# Output only. Timestamp the Recommendation Engine was created at.
|
872
|
+
# Corresponds to the JSON property `createTime`
|
873
|
+
# @return [String]
|
874
|
+
attr_accessor :create_time
|
875
|
+
|
876
|
+
# The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
|
877
|
+
# SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
|
878
|
+
# most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
|
879
|
+
# DataStores in the same Collection can be associated here. Note that when used
|
880
|
+
# in CreateEngineRequest, one DataStore id must be provided as the system will
|
881
|
+
# use it for necessary intializations.
|
882
|
+
# Corresponds to the JSON property `dataStoreIds`
|
883
|
+
# @return [Array<String>]
|
884
|
+
attr_accessor :data_store_ids
|
885
|
+
|
886
|
+
# Required. The display name of the engine. Should be human readable. UTF-8
|
887
|
+
# encoded string with limit of 1024 characters.
|
888
|
+
# Corresponds to the JSON property `displayName`
|
889
|
+
# @return [String]
|
890
|
+
attr_accessor :display_name
|
891
|
+
|
892
|
+
# The industry vertical that the engine registers. The restriction of the Engine
|
893
|
+
# industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
|
894
|
+
# Vertical on Engine has to match vertical of the DataStore liniked to the
|
895
|
+
# engine.
|
896
|
+
# Corresponds to the JSON property `industryVertical`
|
897
|
+
# @return [String]
|
898
|
+
attr_accessor :industry_vertical
|
899
|
+
|
900
|
+
# Additional config specs for a Media Recommendation engine.
|
901
|
+
# Corresponds to the JSON property `mediaRecommendationEngineConfig`
|
902
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
|
903
|
+
attr_accessor :media_recommendation_engine_config
|
904
|
+
|
905
|
+
# Immutable. The fully qualified resource name of the engine. This field must be
|
906
|
+
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
907
|
+
# projects/`project_number`/locations/`location`/collections/`collection`/
|
908
|
+
# engines/`engine`` engine should be 1-63 characters, and valid characters are /
|
909
|
+
# a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
910
|
+
# Corresponds to the JSON property `name`
|
911
|
+
# @return [String]
|
912
|
+
attr_accessor :name
|
913
|
+
|
914
|
+
# Additional information of a recommendation engine.
|
915
|
+
# Corresponds to the JSON property `recommendationMetadata`
|
916
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata]
|
917
|
+
attr_accessor :recommendation_metadata
|
918
|
+
|
919
|
+
# Configurations for a Search Engine.
|
920
|
+
# Corresponds to the JSON property `searchEngineConfig`
|
921
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig]
|
922
|
+
attr_accessor :search_engine_config
|
923
|
+
|
924
|
+
# Additional config specs for a `similar-items` engine.
|
925
|
+
# Corresponds to the JSON property `similarDocumentsConfig`
|
926
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig]
|
927
|
+
attr_accessor :similar_documents_config
|
928
|
+
|
929
|
+
# Required. The solutions of the engine.
|
930
|
+
# Corresponds to the JSON property `solutionType`
|
931
|
+
# @return [String]
|
932
|
+
attr_accessor :solution_type
|
933
|
+
|
934
|
+
# Output only. Timestamp the Recommendation Engine was last updated.
|
935
|
+
# Corresponds to the JSON property `updateTime`
|
936
|
+
# @return [String]
|
937
|
+
attr_accessor :update_time
|
938
|
+
|
939
|
+
def initialize(**args)
|
940
|
+
update!(**args)
|
941
|
+
end
|
942
|
+
|
943
|
+
# Update properties of this object
|
944
|
+
def update!(**args)
|
945
|
+
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
946
|
+
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
947
|
+
@common_config = args[:common_config] if args.key?(:common_config)
|
948
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
949
|
+
@data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
|
950
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
951
|
+
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
952
|
+
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
953
|
+
@name = args[:name] if args.key?(:name)
|
954
|
+
@recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
|
955
|
+
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
956
|
+
@similar_documents_config = args[:similar_documents_config] if args.key?(:similar_documents_config)
|
957
|
+
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
958
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
959
|
+
end
|
960
|
+
end
|
961
|
+
|
962
|
+
# Configurations for a Chat Engine.
|
963
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
|
964
|
+
include Google::Apis::Core::Hashable
|
965
|
+
|
966
|
+
# Configurations for generating a Dialogflow agent. Note that these
|
967
|
+
# configurations are one-time consumed by and passed to Dialogflow service. It
|
968
|
+
# means they cannot be retrieved using EngineService.GetEngine or EngineService.
|
969
|
+
# ListEngines API after engine creation.
|
970
|
+
# Corresponds to the JSON property `agentCreationConfig`
|
971
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
|
972
|
+
attr_accessor :agent_creation_config
|
973
|
+
|
974
|
+
# The resource name of an exist Dialogflow agent to link to this Chat Engine.
|
975
|
+
# Customers can either provide `agent_creation_config` to create agent or
|
976
|
+
# provide an agent name that links the agent with the Chat engine. Format: `
|
977
|
+
# projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
|
978
|
+
# one-time consumed by and passed to Dialogflow service. It means they cannot be
|
979
|
+
# retrieved using EngineService.GetEngine or EngineService.ListEngines API after
|
980
|
+
# engine creation. Please use chat_engine_metadata.dialogflow_agent for actual
|
981
|
+
# agent association after Engine is created.
|
982
|
+
# Corresponds to the JSON property `dialogflowAgentToLink`
|
983
|
+
# @return [String]
|
984
|
+
attr_accessor :dialogflow_agent_to_link
|
985
|
+
|
986
|
+
def initialize(**args)
|
987
|
+
update!(**args)
|
988
|
+
end
|
989
|
+
|
990
|
+
# Update properties of this object
|
991
|
+
def update!(**args)
|
992
|
+
@agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
|
993
|
+
@dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
|
994
|
+
end
|
995
|
+
end
|
996
|
+
|
997
|
+
# Configurations for generating a Dialogflow agent. Note that these
|
998
|
+
# configurations are one-time consumed by and passed to Dialogflow service. It
|
999
|
+
# means they cannot be retrieved using EngineService.GetEngine or EngineService.
|
1000
|
+
# ListEngines API after engine creation.
|
1001
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
|
1002
|
+
include Google::Apis::Core::Hashable
|
1003
|
+
|
1004
|
+
# Name of the company, organization or other entity that the agent represents.
|
1005
|
+
# Used for knowledge connector LLM prompt and for knowledge search.
|
1006
|
+
# Corresponds to the JSON property `business`
|
1007
|
+
# @return [String]
|
1008
|
+
attr_accessor :business
|
1009
|
+
|
1010
|
+
# Required. The default language of the agent as a language tag. See [Language
|
1011
|
+
# Support](https://cloud.google.com/dialogflow/docs/reference/language) for a
|
1012
|
+
# list of the currently supported language codes.
|
1013
|
+
# Corresponds to the JSON property `defaultLanguageCode`
|
1014
|
+
# @return [String]
|
1015
|
+
attr_accessor :default_language_code
|
1016
|
+
|
1017
|
+
# Required. The time zone of the agent from the [time zone database](https://www.
|
1018
|
+
# iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
1019
|
+
# Corresponds to the JSON property `timeZone`
|
1020
|
+
# @return [String]
|
1021
|
+
attr_accessor :time_zone
|
1022
|
+
|
1023
|
+
def initialize(**args)
|
1024
|
+
update!(**args)
|
1025
|
+
end
|
1026
|
+
|
1027
|
+
# Update properties of this object
|
1028
|
+
def update!(**args)
|
1029
|
+
@business = args[:business] if args.key?(:business)
|
1030
|
+
@default_language_code = args[:default_language_code] if args.key?(:default_language_code)
|
1031
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
1032
|
+
end
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# Additional information of a Chat Engine. Fields in this message are output
|
1036
|
+
# only.
|
1037
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
|
1038
|
+
include Google::Apis::Core::Hashable
|
1039
|
+
|
1040
|
+
# The resource name of a Dialogflow agent, that this Chat Engine refers to.
|
1041
|
+
# Format: `projects//locations//agents/`.
|
1042
|
+
# Corresponds to the JSON property `dialogflowAgent`
|
1043
|
+
# @return [String]
|
1044
|
+
attr_accessor :dialogflow_agent
|
1045
|
+
|
1046
|
+
def initialize(**args)
|
1047
|
+
update!(**args)
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# Update properties of this object
|
1051
|
+
def update!(**args)
|
1052
|
+
@dialogflow_agent = args[:dialogflow_agent] if args.key?(:dialogflow_agent)
|
1053
|
+
end
|
1054
|
+
end
|
1055
|
+
|
1056
|
+
# Common configurations for an Engine.
|
1057
|
+
class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
|
1058
|
+
include Google::Apis::Core::Hashable
|
1059
|
+
|
1060
|
+
# The name of the company, business or entity that is associated with the engine.
|
1061
|
+
# Setting this may help improve LLM related features.
|
1062
|
+
# Corresponds to the JSON property `companyName`
|
1063
|
+
# @return [String]
|
1064
|
+
attr_accessor :company_name
|
1065
|
+
|
1066
|
+
def initialize(**args)
|
1067
|
+
update!(**args)
|
1068
|
+
end
|
1069
|
+
|
1070
|
+
# Update properties of this object
|
1071
|
+
def update!(**args)
|
1072
|
+
@company_name = args[:company_name] if args.key?(:company_name)
|
1073
|
+
end
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
# Additional config specs for a Media Recommendation engine.
|
1077
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
1078
|
+
include Google::Apis::Core::Hashable
|
1079
|
+
|
1080
|
+
# The optimization objective e.g. `cvr`. This field together with
|
1081
|
+
# optimization_objective describe engine metadata to use to control engine
|
1082
|
+
# training and serving. Currently supported values: `ctr`, `cvr`. If not
|
1083
|
+
# specified, we choose default based on engine type. Default depends on type of
|
1084
|
+
# recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
|
1085
|
+
# Corresponds to the JSON property `optimizationObjective`
|
1086
|
+
# @return [String]
|
1087
|
+
attr_accessor :optimization_objective
|
1088
|
+
|
1089
|
+
# Custom threshold for `cvr` optimization_objective.
|
1090
|
+
# Corresponds to the JSON property `optimizationObjectiveConfig`
|
1091
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
|
1092
|
+
attr_accessor :optimization_objective_config
|
1093
|
+
|
1094
|
+
# The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
|
1095
|
+
# part of the cost of running the service is frequency of training - this can be
|
1096
|
+
# used to determine when to train engine in order to control cost. If not
|
1097
|
+
# specified: the default value for `CreateEngine` method is `TRAINING`. The
|
1098
|
+
# default value for `UpdateEngine` method is to keep the state the same as
|
1099
|
+
# before.
|
1100
|
+
# Corresponds to the JSON property `trainingState`
|
1101
|
+
# @return [String]
|
1102
|
+
attr_accessor :training_state
|
1103
|
+
|
1104
|
+
# Required. The type of engine e.g. `recommended-for-you`. This field together
|
1105
|
+
# with optimization_objective describe engine metadata to use to control engine
|
1106
|
+
# training and serving. Currently supported values: `recommended-for-you`, `
|
1107
|
+
# others-you-may-like`, `more-like-this`, `most-popular-items`.
|
1108
|
+
# Corresponds to the JSON property `type`
|
1109
|
+
# @return [String]
|
1110
|
+
attr_accessor :type
|
1111
|
+
|
1112
|
+
def initialize(**args)
|
1113
|
+
update!(**args)
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
# Update properties of this object
|
1117
|
+
def update!(**args)
|
1118
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
1119
|
+
@optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
|
1120
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
1121
|
+
@type = args[:type] if args.key?(:type)
|
1122
|
+
end
|
1123
|
+
end
|
1124
|
+
|
1125
|
+
# Custom threshold for `cvr` optimization_objective.
|
1126
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
1127
|
+
include Google::Apis::Core::Hashable
|
1128
|
+
|
1129
|
+
# Required. The name of the field to target. Currently supported values: `watch-
|
1130
|
+
# percentage`, `watch-time`.
|
1131
|
+
# Corresponds to the JSON property `targetField`
|
1132
|
+
# @return [String]
|
1133
|
+
attr_accessor :target_field
|
1134
|
+
|
1135
|
+
# Required. The threshold to be applied to the target (e.g., 0.5).
|
1136
|
+
# Corresponds to the JSON property `targetFieldValueFloat`
|
1137
|
+
# @return [Float]
|
1138
|
+
attr_accessor :target_field_value_float
|
1139
|
+
|
1140
|
+
def initialize(**args)
|
1141
|
+
update!(**args)
|
1142
|
+
end
|
1143
|
+
|
1144
|
+
# Update properties of this object
|
1145
|
+
def update!(**args)
|
1146
|
+
@target_field = args[:target_field] if args.key?(:target_field)
|
1147
|
+
@target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
|
1148
|
+
end
|
1149
|
+
end
|
1150
|
+
|
1151
|
+
# Additional information of a recommendation engine.
|
1152
|
+
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
1153
|
+
include Google::Apis::Core::Hashable
|
1154
|
+
|
1155
|
+
# Output only. The state of data requirements for this engine: `DATA_OK` and `
|
1156
|
+
# DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state.
|
1157
|
+
# Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines
|
1158
|
+
# were trained successfully before, but cannot be refreshed because the
|
1159
|
+
# underlying engine no longer has sufficient data for training.
|
1160
|
+
# Corresponds to the JSON property `dataState`
|
1161
|
+
# @return [String]
|
1162
|
+
attr_accessor :data_state
|
1163
|
+
|
1164
|
+
# Output only. The timestamp when the latest successful tune finished. Only
|
1165
|
+
# applicable on Media Recommendation engines.
|
1166
|
+
# Corresponds to the JSON property `lastTuneTime`
|
1167
|
+
# @return [String]
|
1168
|
+
attr_accessor :last_tune_time
|
1169
|
+
|
1170
|
+
# Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
|
1171
|
+
# Corresponds to the JSON property `servingState`
|
1172
|
+
# @return [String]
|
1173
|
+
attr_accessor :serving_state
|
1174
|
+
|
1175
|
+
# Output only. The latest tune operation id associated with the engine. Only
|
1176
|
+
# applicable on Media Recommendation engines. If present, this operation id can
|
1177
|
+
# be used to determine if there is an ongoing tune for this engine. To check the
|
1178
|
+
# operation status, send the GetOperation request with this operation id in the
|
1179
|
+
# engine resource format. If no tuning has happened for this engine, the string
|
1180
|
+
# is empty.
|
1181
|
+
# Corresponds to the JSON property `tuningOperation`
|
1182
|
+
# @return [String]
|
1183
|
+
attr_accessor :tuning_operation
|
1184
|
+
|
1185
|
+
def initialize(**args)
|
1186
|
+
update!(**args)
|
1187
|
+
end
|
1188
|
+
|
1189
|
+
# Update properties of this object
|
1190
|
+
def update!(**args)
|
1191
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
1192
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
1193
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
1194
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
1195
|
+
end
|
1196
|
+
end
|
1197
|
+
|
1198
|
+
# Configurations for a Search Engine.
|
1199
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
|
1200
|
+
include Google::Apis::Core::Hashable
|
1201
|
+
|
1202
|
+
# The add-on that this search engine enables.
|
1203
|
+
# Corresponds to the JSON property `searchAddOns`
|
1204
|
+
# @return [Array<String>]
|
1205
|
+
attr_accessor :search_add_ons
|
1206
|
+
|
1207
|
+
# The search feature tier of this engine. Different tiers might have different
|
1208
|
+
# pricing. To learn more, please check the pricing documentation. Defaults to
|
1209
|
+
# SearchTier.SEARCH_TIER_STANDARD if not specified.
|
1210
|
+
# Corresponds to the JSON property `searchTier`
|
1211
|
+
# @return [String]
|
1212
|
+
attr_accessor :search_tier
|
1213
|
+
|
1214
|
+
def initialize(**args)
|
1215
|
+
update!(**args)
|
1216
|
+
end
|
1217
|
+
|
1218
|
+
# Update properties of this object
|
1219
|
+
def update!(**args)
|
1220
|
+
@search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
|
1221
|
+
@search_tier = args[:search_tier] if args.key?(:search_tier)
|
1222
|
+
end
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
# Additional config specs for a `similar-items` engine.
|
1226
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
|
1227
|
+
include Google::Apis::Core::Hashable
|
1228
|
+
|
1229
|
+
def initialize(**args)
|
1230
|
+
update!(**args)
|
1231
|
+
end
|
1232
|
+
|
1233
|
+
# Update properties of this object
|
1234
|
+
def update!(**args)
|
1235
|
+
end
|
1236
|
+
end
|
1237
|
+
|
677
1238
|
# Configurations for fields of a schema. For example, configuring a field is
|
678
1239
|
# indexable, or searchable.
|
679
1240
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -1397,6 +1958,40 @@ module Google
|
|
1397
1958
|
end
|
1398
1959
|
end
|
1399
1960
|
|
1961
|
+
# Metadata associated with a tune operation.
|
1962
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
1963
|
+
include Google::Apis::Core::Hashable
|
1964
|
+
|
1965
|
+
# Required. The resource name of the engine that this tune applies to. Format: `
|
1966
|
+
# projects/`project_number`/locations/`location_id`/collections/`collection_id`/
|
1967
|
+
# engines/`engine_id``
|
1968
|
+
# Corresponds to the JSON property `engine`
|
1969
|
+
# @return [String]
|
1970
|
+
attr_accessor :engine
|
1971
|
+
|
1972
|
+
def initialize(**args)
|
1973
|
+
update!(**args)
|
1974
|
+
end
|
1975
|
+
|
1976
|
+
# Update properties of this object
|
1977
|
+
def update!(**args)
|
1978
|
+
@engine = args[:engine] if args.key?(:engine)
|
1979
|
+
end
|
1980
|
+
end
|
1981
|
+
|
1982
|
+
# Response associated with a tune operation.
|
1983
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
|
1984
|
+
include Google::Apis::Core::Hashable
|
1985
|
+
|
1986
|
+
def initialize(**args)
|
1987
|
+
update!(**args)
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
# Update properties of this object
|
1991
|
+
def update!(**args)
|
1992
|
+
end
|
1993
|
+
end
|
1994
|
+
|
1400
1995
|
# Metadata for UpdateSchema LRO.
|
1401
1996
|
class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
|
1402
1997
|
include Google::Apis::Core::Hashable
|
@@ -3078,6 +3673,18 @@ module Google
|
|
3078
3673
|
# @return [String]
|
3079
3674
|
attr_accessor :branch
|
3080
3675
|
|
3676
|
+
# The default filter that is applied when a user performs a search without
|
3677
|
+
# checking any filters on the search page. The filter applied to every search
|
3678
|
+
# request when quality improvement such as query expansion is needed. In the
|
3679
|
+
# case a query does not have a sufficient amount of results this filter will be
|
3680
|
+
# used to determine whether or not to enable the query expansion flow. The
|
3681
|
+
# original filter will still be used for the query expanded search. This field
|
3682
|
+
# is strongly recommended to achieve high search quality. For more information
|
3683
|
+
# about filter syntax, see SearchRequest.filter.
|
3684
|
+
# Corresponds to the JSON property `canonicalFilter`
|
3685
|
+
# @return [String]
|
3686
|
+
attr_accessor :canonical_filter
|
3687
|
+
|
3081
3688
|
# A specification for configuring the behavior of content search.
|
3082
3689
|
# Corresponds to the JSON property `contentSearchSpec`
|
3083
3690
|
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec]
|
@@ -3236,6 +3843,7 @@ module Google
|
|
3236
3843
|
def update!(**args)
|
3237
3844
|
@boost_spec = args[:boost_spec] if args.key?(:boost_spec)
|
3238
3845
|
@branch = args[:branch] if args.key?(:branch)
|
3846
|
+
@canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
|
3239
3847
|
@content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
|
3240
3848
|
@embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
|
3241
3849
|
@facet_specs = args[:facet_specs] if args.key?(:facet_specs)
|
@@ -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.28.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 = "20231110"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -130,18 +130,108 @@ module Google
|
|
130
130
|
include Google::Apis::Core::JsonObjectSupport
|
131
131
|
end
|
132
132
|
|
133
|
+
class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
|
134
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
135
|
+
|
136
|
+
include Google::Apis::Core::JsonObjectSupport
|
137
|
+
end
|
138
|
+
|
139
|
+
class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
|
140
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
141
|
+
|
142
|
+
include Google::Apis::Core::JsonObjectSupport
|
143
|
+
end
|
144
|
+
|
133
145
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
134
146
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
135
147
|
|
136
148
|
include Google::Apis::Core::JsonObjectSupport
|
137
149
|
end
|
138
150
|
|
151
|
+
class GoogleCloudDiscoveryengineV1alphaDataStore
|
152
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
153
|
+
|
154
|
+
include Google::Apis::Core::JsonObjectSupport
|
155
|
+
end
|
156
|
+
|
157
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
|
158
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
159
|
+
|
160
|
+
include Google::Apis::Core::JsonObjectSupport
|
161
|
+
end
|
162
|
+
|
163
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
|
164
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
|
+
|
166
|
+
include Google::Apis::Core::JsonObjectSupport
|
167
|
+
end
|
168
|
+
|
139
169
|
class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
|
140
170
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
141
171
|
|
142
172
|
include Google::Apis::Core::JsonObjectSupport
|
143
173
|
end
|
144
174
|
|
175
|
+
class GoogleCloudDiscoveryengineV1alphaEngine
|
176
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
177
|
+
|
178
|
+
include Google::Apis::Core::JsonObjectSupport
|
179
|
+
end
|
180
|
+
|
181
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
|
182
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
183
|
+
|
184
|
+
include Google::Apis::Core::JsonObjectSupport
|
185
|
+
end
|
186
|
+
|
187
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
|
188
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
189
|
+
|
190
|
+
include Google::Apis::Core::JsonObjectSupport
|
191
|
+
end
|
192
|
+
|
193
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
|
194
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
195
|
+
|
196
|
+
include Google::Apis::Core::JsonObjectSupport
|
197
|
+
end
|
198
|
+
|
199
|
+
class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
|
200
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
201
|
+
|
202
|
+
include Google::Apis::Core::JsonObjectSupport
|
203
|
+
end
|
204
|
+
|
205
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
206
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
207
|
+
|
208
|
+
include Google::Apis::Core::JsonObjectSupport
|
209
|
+
end
|
210
|
+
|
211
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
212
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
213
|
+
|
214
|
+
include Google::Apis::Core::JsonObjectSupport
|
215
|
+
end
|
216
|
+
|
217
|
+
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
218
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
219
|
+
|
220
|
+
include Google::Apis::Core::JsonObjectSupport
|
221
|
+
end
|
222
|
+
|
223
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
|
224
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
225
|
+
|
226
|
+
include Google::Apis::Core::JsonObjectSupport
|
227
|
+
end
|
228
|
+
|
229
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
|
230
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
231
|
+
|
232
|
+
include Google::Apis::Core::JsonObjectSupport
|
233
|
+
end
|
234
|
+
|
145
235
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
146
236
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
147
237
|
|
@@ -256,6 +346,18 @@ module Google
|
|
256
346
|
include Google::Apis::Core::JsonObjectSupport
|
257
347
|
end
|
258
348
|
|
349
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
350
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
351
|
+
|
352
|
+
include Google::Apis::Core::JsonObjectSupport
|
353
|
+
end
|
354
|
+
|
355
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
|
356
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
357
|
+
|
358
|
+
include Google::Apis::Core::JsonObjectSupport
|
359
|
+
end
|
360
|
+
|
259
361
|
class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
|
260
362
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
261
363
|
|
@@ -892,6 +994,22 @@ module Google
|
|
892
994
|
end
|
893
995
|
end
|
894
996
|
|
997
|
+
class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
|
998
|
+
# @private
|
999
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1000
|
+
property :create_time, as: 'createTime'
|
1001
|
+
property :update_time, as: 'updateTime'
|
1002
|
+
end
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
|
1006
|
+
# @private
|
1007
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1008
|
+
property :create_time, as: 'createTime'
|
1009
|
+
property :update_time, as: 'updateTime'
|
1010
|
+
end
|
1011
|
+
end
|
1012
|
+
|
895
1013
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
896
1014
|
# @private
|
897
1015
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -900,6 +1018,35 @@ module Google
|
|
900
1018
|
end
|
901
1019
|
end
|
902
1020
|
|
1021
|
+
class GoogleCloudDiscoveryengineV1alphaDataStore
|
1022
|
+
# @private
|
1023
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1024
|
+
property :content_config, as: 'contentConfig'
|
1025
|
+
property :create_time, as: 'createTime'
|
1026
|
+
property :default_schema_id, as: 'defaultSchemaId'
|
1027
|
+
property :display_name, as: 'displayName'
|
1028
|
+
property :industry_vertical, as: 'industryVertical'
|
1029
|
+
property :name, as: 'name'
|
1030
|
+
collection :solution_types, as: 'solutionTypes'
|
1031
|
+
end
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
|
1035
|
+
# @private
|
1036
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1037
|
+
property :create_time, as: 'createTime'
|
1038
|
+
property :update_time, as: 'updateTime'
|
1039
|
+
end
|
1040
|
+
end
|
1041
|
+
|
1042
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
|
1043
|
+
# @private
|
1044
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1045
|
+
property :create_time, as: 'createTime'
|
1046
|
+
property :update_time, as: 'updateTime'
|
1047
|
+
end
|
1048
|
+
end
|
1049
|
+
|
903
1050
|
class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
|
904
1051
|
# @private
|
905
1052
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -908,6 +1055,108 @@ module Google
|
|
908
1055
|
end
|
909
1056
|
end
|
910
1057
|
|
1058
|
+
class GoogleCloudDiscoveryengineV1alphaEngine
|
1059
|
+
# @private
|
1060
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1061
|
+
property :chat_engine_config, as: 'chatEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig::Representation
|
1062
|
+
|
1063
|
+
property :chat_engine_metadata, as: 'chatEngineMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata::Representation
|
1064
|
+
|
1065
|
+
property :common_config, as: 'commonConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig::Representation
|
1066
|
+
|
1067
|
+
property :create_time, as: 'createTime'
|
1068
|
+
collection :data_store_ids, as: 'dataStoreIds'
|
1069
|
+
property :display_name, as: 'displayName'
|
1070
|
+
property :industry_vertical, as: 'industryVertical'
|
1071
|
+
property :media_recommendation_engine_config, as: 'mediaRecommendationEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig::Representation
|
1072
|
+
|
1073
|
+
property :name, as: 'name'
|
1074
|
+
property :recommendation_metadata, as: 'recommendationMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata::Representation
|
1075
|
+
|
1076
|
+
property :search_engine_config, as: 'searchEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig::Representation
|
1077
|
+
|
1078
|
+
property :similar_documents_config, as: 'similarDocumentsConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig::Representation
|
1079
|
+
|
1080
|
+
property :solution_type, as: 'solutionType'
|
1081
|
+
property :update_time, as: 'updateTime'
|
1082
|
+
end
|
1083
|
+
end
|
1084
|
+
|
1085
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
|
1086
|
+
# @private
|
1087
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1088
|
+
property :agent_creation_config, as: 'agentCreationConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig::Representation
|
1089
|
+
|
1090
|
+
property :dialogflow_agent_to_link, as: 'dialogflowAgentToLink'
|
1091
|
+
end
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
|
1095
|
+
# @private
|
1096
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1097
|
+
property :business, as: 'business'
|
1098
|
+
property :default_language_code, as: 'defaultLanguageCode'
|
1099
|
+
property :time_zone, as: 'timeZone'
|
1100
|
+
end
|
1101
|
+
end
|
1102
|
+
|
1103
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
|
1104
|
+
# @private
|
1105
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1106
|
+
property :dialogflow_agent, as: 'dialogflowAgent'
|
1107
|
+
end
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
|
1111
|
+
# @private
|
1112
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1113
|
+
property :company_name, as: 'companyName'
|
1114
|
+
end
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
1118
|
+
# @private
|
1119
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1120
|
+
property :optimization_objective, as: 'optimizationObjective'
|
1121
|
+
property :optimization_objective_config, as: 'optimizationObjectiveConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig::Representation
|
1122
|
+
|
1123
|
+
property :training_state, as: 'trainingState'
|
1124
|
+
property :type, as: 'type'
|
1125
|
+
end
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
1129
|
+
# @private
|
1130
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1131
|
+
property :target_field, as: 'targetField'
|
1132
|
+
property :target_field_value_float, as: 'targetFieldValueFloat'
|
1133
|
+
end
|
1134
|
+
end
|
1135
|
+
|
1136
|
+
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
1137
|
+
# @private
|
1138
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1139
|
+
property :data_state, as: 'dataState'
|
1140
|
+
property :last_tune_time, as: 'lastTuneTime'
|
1141
|
+
property :serving_state, as: 'servingState'
|
1142
|
+
property :tuning_operation, as: 'tuningOperation'
|
1143
|
+
end
|
1144
|
+
end
|
1145
|
+
|
1146
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
|
1147
|
+
# @private
|
1148
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1149
|
+
collection :search_add_ons, as: 'searchAddOns'
|
1150
|
+
property :search_tier, as: 'searchTier'
|
1151
|
+
end
|
1152
|
+
end
|
1153
|
+
|
1154
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
|
1155
|
+
# @private
|
1156
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1157
|
+
end
|
1158
|
+
end
|
1159
|
+
|
911
1160
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
912
1161
|
# @private
|
913
1162
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1096,6 +1345,19 @@ module Google
|
|
1096
1345
|
end
|
1097
1346
|
end
|
1098
1347
|
|
1348
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
1349
|
+
# @private
|
1350
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1351
|
+
property :engine, as: 'engine'
|
1352
|
+
end
|
1353
|
+
end
|
1354
|
+
|
1355
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
|
1356
|
+
# @private
|
1357
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1358
|
+
end
|
1359
|
+
end
|
1360
|
+
|
1099
1361
|
class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
|
1100
1362
|
# @private
|
1101
1363
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1542,6 +1804,7 @@ module Google
|
|
1542
1804
|
property :boost_spec, as: 'boostSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec::Representation
|
1543
1805
|
|
1544
1806
|
property :branch, as: 'branch'
|
1807
|
+
property :canonical_filter, as: 'canonicalFilter'
|
1545
1808
|
property :content_search_spec, as: 'contentSearchSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec::Representation
|
1546
1809
|
|
1547
1810
|
property :embedding_spec, as: 'embeddingSpec', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec::Representation
|
@@ -49,6 +49,77 @@ module Google
|
|
49
49
|
@batch_path = 'batch'
|
50
50
|
end
|
51
51
|
|
52
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
53
|
+
# to poll the operation result at intervals as recommended by the API service.
|
54
|
+
# @param [String] name
|
55
|
+
# The name of the operation resource.
|
56
|
+
# @param [String] fields
|
57
|
+
# Selector specifying which fields to include in a partial response.
|
58
|
+
# @param [String] quota_user
|
59
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
60
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
61
|
+
# @param [Google::Apis::RequestOptions] options
|
62
|
+
# Request-specific options
|
63
|
+
#
|
64
|
+
# @yield [result, err] Result & error if block supplied
|
65
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation] parsed result object
|
66
|
+
# @yieldparam err [StandardError] error object if request failed
|
67
|
+
#
|
68
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation]
|
69
|
+
#
|
70
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
71
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
72
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
73
|
+
def get_project_location_collection_data_connector_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
74
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
75
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation::Representation
|
76
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningOperation
|
77
|
+
command.params['name'] = name unless name.nil?
|
78
|
+
command.query['fields'] = fields unless fields.nil?
|
79
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
80
|
+
execute_or_queue_command(command, &block)
|
81
|
+
end
|
82
|
+
|
83
|
+
# Lists operations that match the specified filter in the request. If the server
|
84
|
+
# doesn't support this method, it returns `UNIMPLEMENTED`.
|
85
|
+
# @param [String] name
|
86
|
+
# The name of the operation's parent resource.
|
87
|
+
# @param [String] filter
|
88
|
+
# The standard list filter.
|
89
|
+
# @param [Fixnum] page_size
|
90
|
+
# The standard list page size.
|
91
|
+
# @param [String] page_token
|
92
|
+
# The standard list page token.
|
93
|
+
# @param [String] fields
|
94
|
+
# Selector specifying which fields to include in a partial response.
|
95
|
+
# @param [String] quota_user
|
96
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
97
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
98
|
+
# @param [Google::Apis::RequestOptions] options
|
99
|
+
# Request-specific options
|
100
|
+
#
|
101
|
+
# @yield [result, err] Result & error if block supplied
|
102
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse] parsed result object
|
103
|
+
# @yieldparam err [StandardError] error object if request failed
|
104
|
+
#
|
105
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse]
|
106
|
+
#
|
107
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
108
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
109
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
110
|
+
def list_project_location_collection_data_connector_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
111
|
+
command = make_simple_command(:get, 'v1beta/{+name}/operations', options)
|
112
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse::Representation
|
113
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleLongrunningListOperationsResponse
|
114
|
+
command.params['name'] = name unless name.nil?
|
115
|
+
command.query['filter'] = filter unless filter.nil?
|
116
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
117
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
118
|
+
command.query['fields'] = fields unless fields.nil?
|
119
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
120
|
+
execute_or_queue_command(command, &block)
|
121
|
+
end
|
122
|
+
|
52
123
|
# Completes the specified user input with keyword suggestions.
|
53
124
|
# @param [String] data_store
|
54
125
|
# Required. The parent data store resource name for which the completion is
|
@@ -1087,10 +1158,14 @@ module Google
|
|
1087
1158
|
|
1088
1159
|
# Makes a recommendation, which requires a contextual user event.
|
1089
1160
|
# @param [String] serving_config
|
1090
|
-
# Required. Full resource name of
|
1091
|
-
# collections/*/
|
1092
|
-
#
|
1093
|
-
#
|
1161
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
1162
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
1163
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
1164
|
+
# created along with your recommendation engine creation. The engine ID will be
|
1165
|
+
# used as the ID of the default serving config. For example, for Engine `
|
1166
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
1167
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
1168
|
+
# engine` for your Recommend requests.
|
1094
1169
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
1095
1170
|
# @param [String] fields
|
1096
1171
|
# Selector specifying which fields to include in a partial response.
|
@@ -1124,9 +1199,11 @@ module Google
|
|
1124
1199
|
# Performs a search.
|
1125
1200
|
# @param [String] serving_config
|
1126
1201
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
1127
|
-
# locations/global/collections/default_collection/
|
1128
|
-
#
|
1129
|
-
#
|
1202
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1203
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1204
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
1205
|
+
# default_serving_config`. This field is used to identify the serving
|
1206
|
+
# configuration name, set of models used to make the search.
|
1130
1207
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
1131
1208
|
# @param [String] fields
|
1132
1209
|
# Selector specifying which fields to include in a partial response.
|
@@ -1492,10 +1569,14 @@ module Google
|
|
1492
1569
|
|
1493
1570
|
# Makes a recommendation, which requires a contextual user event.
|
1494
1571
|
# @param [String] serving_config
|
1495
|
-
# Required. Full resource name of
|
1496
|
-
# collections/*/
|
1497
|
-
#
|
1498
|
-
#
|
1572
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
1573
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
1574
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
1575
|
+
# created along with your recommendation engine creation. The engine ID will be
|
1576
|
+
# used as the ID of the default serving config. For example, for Engine `
|
1577
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
1578
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
1579
|
+
# engine` for your Recommend requests.
|
1499
1580
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
1500
1581
|
# @param [String] fields
|
1501
1582
|
# Selector specifying which fields to include in a partial response.
|
@@ -1529,9 +1610,11 @@ module Google
|
|
1529
1610
|
# Performs a search.
|
1530
1611
|
# @param [String] serving_config
|
1531
1612
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
1532
|
-
# locations/global/collections/default_collection/
|
1533
|
-
#
|
1534
|
-
#
|
1613
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1614
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1615
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
1616
|
+
# default_serving_config`. This field is used to identify the serving
|
1617
|
+
# configuration name, set of models used to make the search.
|
1535
1618
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
1536
1619
|
# @param [String] fields
|
1537
1620
|
# Selector specifying which fields to include in a partial response.
|
@@ -2600,10 +2683,14 @@ module Google
|
|
2600
2683
|
|
2601
2684
|
# Makes a recommendation, which requires a contextual user event.
|
2602
2685
|
# @param [String] serving_config
|
2603
|
-
# Required. Full resource name of
|
2604
|
-
# collections/*/
|
2605
|
-
#
|
2606
|
-
#
|
2686
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
2687
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
2688
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
2689
|
+
# created along with your recommendation engine creation. The engine ID will be
|
2690
|
+
# used as the ID of the default serving config. For example, for Engine `
|
2691
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
2692
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
2693
|
+
# engine` for your Recommend requests.
|
2607
2694
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
2608
2695
|
# @param [String] fields
|
2609
2696
|
# Selector specifying which fields to include in a partial response.
|
@@ -2637,9 +2724,11 @@ module Google
|
|
2637
2724
|
# Performs a search.
|
2638
2725
|
# @param [String] serving_config
|
2639
2726
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
2640
|
-
# locations/global/collections/default_collection/
|
2641
|
-
#
|
2642
|
-
#
|
2727
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
2728
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
2729
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
2730
|
+
# default_serving_config`. This field is used to identify the serving
|
2731
|
+
# configuration name, set of models used to make the search.
|
2643
2732
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
2644
2733
|
# @param [String] fields
|
2645
2734
|
# Selector specifying which fields to include in a partial response.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.28.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-11-
|
11
|
+
date: 2023-11-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.28.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|