google-apis-discoveryengine_v1beta 0.26.0 → 0.27.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 +4 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +586 -0
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +261 -0
- data/lib/google/apis/discoveryengine_v1beta/service.rb +39 -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: 873c42659dc8bb3d09db30f5be699980866051fd7ab13d0739f8ca3da99a12d4
|
4
|
+
data.tar.gz: f0ebb0c73892777067cdd771d4af653ad882bb29f30dbd40afd420bae5d957f9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8681f059acb830c9c52a203d9753e02019d832fb200b8d55278c9112bb7b8e9a1b2f5131f60ffd872381ccee6d23f6277fb0bee438a0b5ac564ec8d3928bae33
|
7
|
+
data.tar.gz: e49c7d2070ffcdfeaefdfa71051e3869f5d19cdb8fc4e232cc29d210c9716b5c0e303804aefefca878ba2ac47cd3f7796093db6aa1aa3a29bb83e1d90945a012
|
data/CHANGELOG.md
CHANGED
@@ -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,384 @@ 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
|
+
# Additional config specs for a Media Recommendation engine.
|
893
|
+
# Corresponds to the JSON property `mediaRecommendationEngineConfig`
|
894
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
|
895
|
+
attr_accessor :media_recommendation_engine_config
|
896
|
+
|
897
|
+
# Immutable. The fully qualified resource name of the engine. This field must be
|
898
|
+
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
899
|
+
# projects/`project_number`/locations/`location`/collections/`collection`/
|
900
|
+
# engines/`engine`` engine should be 1-63 characters, and valid characters are /
|
901
|
+
# a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
902
|
+
# Corresponds to the JSON property `name`
|
903
|
+
# @return [String]
|
904
|
+
attr_accessor :name
|
905
|
+
|
906
|
+
# Additional information of a recommendation engine.
|
907
|
+
# Corresponds to the JSON property `recommendationMetadata`
|
908
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata]
|
909
|
+
attr_accessor :recommendation_metadata
|
910
|
+
|
911
|
+
# Configurations for a Search Engine.
|
912
|
+
# Corresponds to the JSON property `searchEngineConfig`
|
913
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig]
|
914
|
+
attr_accessor :search_engine_config
|
915
|
+
|
916
|
+
# Additional config specs for a `similar-items` engine.
|
917
|
+
# Corresponds to the JSON property `similarDocumentsConfig`
|
918
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig]
|
919
|
+
attr_accessor :similar_documents_config
|
920
|
+
|
921
|
+
# Required. The solutions of the engine.
|
922
|
+
# Corresponds to the JSON property `solutionType`
|
923
|
+
# @return [String]
|
924
|
+
attr_accessor :solution_type
|
925
|
+
|
926
|
+
# Output only. Timestamp the Recommendation Engine was last updated.
|
927
|
+
# Corresponds to the JSON property `updateTime`
|
928
|
+
# @return [String]
|
929
|
+
attr_accessor :update_time
|
930
|
+
|
931
|
+
def initialize(**args)
|
932
|
+
update!(**args)
|
933
|
+
end
|
934
|
+
|
935
|
+
# Update properties of this object
|
936
|
+
def update!(**args)
|
937
|
+
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
938
|
+
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
939
|
+
@common_config = args[:common_config] if args.key?(:common_config)
|
940
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
941
|
+
@data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
|
942
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
943
|
+
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
944
|
+
@name = args[:name] if args.key?(:name)
|
945
|
+
@recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
|
946
|
+
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
947
|
+
@similar_documents_config = args[:similar_documents_config] if args.key?(:similar_documents_config)
|
948
|
+
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
949
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
950
|
+
end
|
951
|
+
end
|
952
|
+
|
953
|
+
# Configurations for a Chat Engine.
|
954
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
|
955
|
+
include Google::Apis::Core::Hashable
|
956
|
+
|
957
|
+
# Configurations for generating a Dialogflow agent. Note that these
|
958
|
+
# configurations are one-time consumed by and passed to Dialogflow service. It
|
959
|
+
# means they cannot be retrieved using GetEngine or ListEngine API after engine
|
960
|
+
# creation.
|
961
|
+
# Corresponds to the JSON property `agentCreationConfig`
|
962
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
|
963
|
+
attr_accessor :agent_creation_config
|
964
|
+
|
965
|
+
# The resource name of an exist Dialogflow agent to link to this Chat Engine.
|
966
|
+
# Customers can either provide `agent_creation_config` to create agent or
|
967
|
+
# provide an agent name that links the agent with the Chat engine. Format: `
|
968
|
+
# projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
|
969
|
+
# one-time consumed by and passed to Dialogflow service. It means they cannot be
|
970
|
+
# retrieved using GetEngine or ListEngine API after engine creation. Please use
|
971
|
+
# Engine.chat_engine_metadata.dialogflow_agent for actual agent association
|
972
|
+
# after Engine is created.
|
973
|
+
# Corresponds to the JSON property `dialogflowAgentToLink`
|
974
|
+
# @return [String]
|
975
|
+
attr_accessor :dialogflow_agent_to_link
|
976
|
+
|
977
|
+
def initialize(**args)
|
978
|
+
update!(**args)
|
979
|
+
end
|
980
|
+
|
981
|
+
# Update properties of this object
|
982
|
+
def update!(**args)
|
983
|
+
@agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
|
984
|
+
@dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
|
985
|
+
end
|
986
|
+
end
|
987
|
+
|
988
|
+
# Configurations for generating a Dialogflow agent. Note that these
|
989
|
+
# configurations are one-time consumed by and passed to Dialogflow service. It
|
990
|
+
# means they cannot be retrieved using GetEngine or ListEngine API after engine
|
991
|
+
# creation.
|
992
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
|
993
|
+
include Google::Apis::Core::Hashable
|
994
|
+
|
995
|
+
# Name of the company, organization or other entity that the agent represents.
|
996
|
+
# Used for knowledge connector LLM prompt and for knowledge search.
|
997
|
+
# Corresponds to the JSON property `business`
|
998
|
+
# @return [String]
|
999
|
+
attr_accessor :business
|
1000
|
+
|
1001
|
+
# Required. The default language of the agent as a language tag. See [Language
|
1002
|
+
# Support](https://cloud.google.com/dialogflow/docs/reference/language) for a
|
1003
|
+
# list of the currently supported language codes.
|
1004
|
+
# Corresponds to the JSON property `defaultLanguageCode`
|
1005
|
+
# @return [String]
|
1006
|
+
attr_accessor :default_language_code
|
1007
|
+
|
1008
|
+
# Required. The time zone of the agent from the [time zone database](https://www.
|
1009
|
+
# iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
1010
|
+
# Corresponds to the JSON property `timeZone`
|
1011
|
+
# @return [String]
|
1012
|
+
attr_accessor :time_zone
|
1013
|
+
|
1014
|
+
def initialize(**args)
|
1015
|
+
update!(**args)
|
1016
|
+
end
|
1017
|
+
|
1018
|
+
# Update properties of this object
|
1019
|
+
def update!(**args)
|
1020
|
+
@business = args[:business] if args.key?(:business)
|
1021
|
+
@default_language_code = args[:default_language_code] if args.key?(:default_language_code)
|
1022
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
1023
|
+
end
|
1024
|
+
end
|
1025
|
+
|
1026
|
+
# Additional information of a Chat Engine. Fields in this message are output
|
1027
|
+
# only.
|
1028
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
|
1029
|
+
include Google::Apis::Core::Hashable
|
1030
|
+
|
1031
|
+
# The resource name of a Dialogflow agent, that this Chat Engine refers to.
|
1032
|
+
# Format: `projects//locations//agents/`.
|
1033
|
+
# Corresponds to the JSON property `dialogflowAgent`
|
1034
|
+
# @return [String]
|
1035
|
+
attr_accessor :dialogflow_agent
|
1036
|
+
|
1037
|
+
def initialize(**args)
|
1038
|
+
update!(**args)
|
1039
|
+
end
|
1040
|
+
|
1041
|
+
# Update properties of this object
|
1042
|
+
def update!(**args)
|
1043
|
+
@dialogflow_agent = args[:dialogflow_agent] if args.key?(:dialogflow_agent)
|
1044
|
+
end
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Common configurations for an Engine.
|
1048
|
+
class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
|
1049
|
+
include Google::Apis::Core::Hashable
|
1050
|
+
|
1051
|
+
# The name of the company, business or entity that is associated with the engine.
|
1052
|
+
# Setting this may help improve LLM related features.
|
1053
|
+
# Corresponds to the JSON property `companyName`
|
1054
|
+
# @return [String]
|
1055
|
+
attr_accessor :company_name
|
1056
|
+
|
1057
|
+
def initialize(**args)
|
1058
|
+
update!(**args)
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# Update properties of this object
|
1062
|
+
def update!(**args)
|
1063
|
+
@company_name = args[:company_name] if args.key?(:company_name)
|
1064
|
+
end
|
1065
|
+
end
|
1066
|
+
|
1067
|
+
# Additional config specs for a Media Recommendation engine.
|
1068
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
1069
|
+
include Google::Apis::Core::Hashable
|
1070
|
+
|
1071
|
+
# The optimization objective e.g. `cvr`. This field together with
|
1072
|
+
# optimization_objective describe engine metadata to use to control engine
|
1073
|
+
# training and serving. Currently supported values: `ctr`, `cvr`. If not
|
1074
|
+
# specified, we choose default based on engine type. Default depends on type of
|
1075
|
+
# recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
|
1076
|
+
# Corresponds to the JSON property `optimizationObjective`
|
1077
|
+
# @return [String]
|
1078
|
+
attr_accessor :optimization_objective
|
1079
|
+
|
1080
|
+
# Custom threshold for `cvr` optimization_objective.
|
1081
|
+
# Corresponds to the JSON property `optimizationObjectiveConfig`
|
1082
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
|
1083
|
+
attr_accessor :optimization_objective_config
|
1084
|
+
|
1085
|
+
# The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
|
1086
|
+
# part of the cost of running the service is frequency of training - this can be
|
1087
|
+
# used to determine when to train engine in order to control cost. If not
|
1088
|
+
# specified: the default value for `CreateEngine` method is `TRAINING`. The
|
1089
|
+
# default value for `UpdateEngine` method is to keep the state the same as
|
1090
|
+
# before.
|
1091
|
+
# Corresponds to the JSON property `trainingState`
|
1092
|
+
# @return [String]
|
1093
|
+
attr_accessor :training_state
|
1094
|
+
|
1095
|
+
# Required. The type of engine e.g. `recommended-for-you`. This field together
|
1096
|
+
# with optimization_objective describe engine metadata to use to control engine
|
1097
|
+
# training and serving. Currently supported values: `recommended-for-you`, `
|
1098
|
+
# others-you-may-like`, `more-like-this`, `most-popular-items`.
|
1099
|
+
# Corresponds to the JSON property `type`
|
1100
|
+
# @return [String]
|
1101
|
+
attr_accessor :type
|
1102
|
+
|
1103
|
+
def initialize(**args)
|
1104
|
+
update!(**args)
|
1105
|
+
end
|
1106
|
+
|
1107
|
+
# Update properties of this object
|
1108
|
+
def update!(**args)
|
1109
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
1110
|
+
@optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
|
1111
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
1112
|
+
@type = args[:type] if args.key?(:type)
|
1113
|
+
end
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
# Custom threshold for `cvr` optimization_objective.
|
1117
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
1118
|
+
include Google::Apis::Core::Hashable
|
1119
|
+
|
1120
|
+
# Required. The name of the field to target. Currently supported values: `watch-
|
1121
|
+
# percentage`, `watch-time`.
|
1122
|
+
# Corresponds to the JSON property `targetField`
|
1123
|
+
# @return [String]
|
1124
|
+
attr_accessor :target_field
|
1125
|
+
|
1126
|
+
# Required. The threshold to be applied to the target (e.g., 0.5).
|
1127
|
+
# Corresponds to the JSON property `targetFieldValueFloat`
|
1128
|
+
# @return [Float]
|
1129
|
+
attr_accessor :target_field_value_float
|
1130
|
+
|
1131
|
+
def initialize(**args)
|
1132
|
+
update!(**args)
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
# Update properties of this object
|
1136
|
+
def update!(**args)
|
1137
|
+
@target_field = args[:target_field] if args.key?(:target_field)
|
1138
|
+
@target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
|
1139
|
+
end
|
1140
|
+
end
|
1141
|
+
|
1142
|
+
# Additional information of a recommendation engine.
|
1143
|
+
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
1144
|
+
include Google::Apis::Core::Hashable
|
1145
|
+
|
1146
|
+
# Output only. The state of data requirements for this engine: `DATA_OK` and `
|
1147
|
+
# DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state.
|
1148
|
+
# Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines
|
1149
|
+
# were trained successfully before, but cannot be refreshed because the
|
1150
|
+
# underlying engine no longer has sufficient data for training.
|
1151
|
+
# Corresponds to the JSON property `dataState`
|
1152
|
+
# @return [String]
|
1153
|
+
attr_accessor :data_state
|
1154
|
+
|
1155
|
+
# Output only. The timestamp when the latest successful tune finished. Only
|
1156
|
+
# applicable on Media Recommendation engines.
|
1157
|
+
# Corresponds to the JSON property `lastTuneTime`
|
1158
|
+
# @return [String]
|
1159
|
+
attr_accessor :last_tune_time
|
1160
|
+
|
1161
|
+
# Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
|
1162
|
+
# Corresponds to the JSON property `servingState`
|
1163
|
+
# @return [String]
|
1164
|
+
attr_accessor :serving_state
|
1165
|
+
|
1166
|
+
# Output only. The latest tune operation id associated with the engine. Only
|
1167
|
+
# applicable on Media Recommendation engines. If present, this operation id can
|
1168
|
+
# be used to determine if there is an ongoing tune for this engine. To check the
|
1169
|
+
# operation status, send the GetOperation request with this operation id in the
|
1170
|
+
# engine resource format. If no tuning has happened for this engine, the string
|
1171
|
+
# is empty.
|
1172
|
+
# Corresponds to the JSON property `tuningOperation`
|
1173
|
+
# @return [String]
|
1174
|
+
attr_accessor :tuning_operation
|
1175
|
+
|
1176
|
+
def initialize(**args)
|
1177
|
+
update!(**args)
|
1178
|
+
end
|
1179
|
+
|
1180
|
+
# Update properties of this object
|
1181
|
+
def update!(**args)
|
1182
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
1183
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
1184
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
1185
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
1186
|
+
end
|
1187
|
+
end
|
1188
|
+
|
1189
|
+
# Configurations for a Search Engine.
|
1190
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
|
1191
|
+
include Google::Apis::Core::Hashable
|
1192
|
+
|
1193
|
+
# The add-on that this search engine enables.
|
1194
|
+
# Corresponds to the JSON property `searchAddOns`
|
1195
|
+
# @return [Array<String>]
|
1196
|
+
attr_accessor :search_add_ons
|
1197
|
+
|
1198
|
+
# The search feature tier of this engine. Different tiers might have different
|
1199
|
+
# pricing. To learn more, please check the pricing documentation. Defaults to
|
1200
|
+
# SearchTier.SEARCH_TIER_STANDARD if not specified.
|
1201
|
+
# Corresponds to the JSON property `searchTier`
|
1202
|
+
# @return [String]
|
1203
|
+
attr_accessor :search_tier
|
1204
|
+
|
1205
|
+
def initialize(**args)
|
1206
|
+
update!(**args)
|
1207
|
+
end
|
1208
|
+
|
1209
|
+
# Update properties of this object
|
1210
|
+
def update!(**args)
|
1211
|
+
@search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
|
1212
|
+
@search_tier = args[:search_tier] if args.key?(:search_tier)
|
1213
|
+
end
|
1214
|
+
end
|
1215
|
+
|
1216
|
+
# Additional config specs for a `similar-items` engine.
|
1217
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
|
1218
|
+
include Google::Apis::Core::Hashable
|
1219
|
+
|
1220
|
+
def initialize(**args)
|
1221
|
+
update!(**args)
|
1222
|
+
end
|
1223
|
+
|
1224
|
+
# Update properties of this object
|
1225
|
+
def update!(**args)
|
1226
|
+
end
|
1227
|
+
end
|
1228
|
+
|
677
1229
|
# Configurations for fields of a schema. For example, configuring a field is
|
678
1230
|
# indexable, or searchable.
|
679
1231
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -1397,6 +1949,40 @@ module Google
|
|
1397
1949
|
end
|
1398
1950
|
end
|
1399
1951
|
|
1952
|
+
# Metadata associated with a tune operation.
|
1953
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
1954
|
+
include Google::Apis::Core::Hashable
|
1955
|
+
|
1956
|
+
# Required. The resource name of the engine that this tune applies to. Format: `
|
1957
|
+
# projects/`project_number`/locations/`location_id`/collections/`collection_id`/
|
1958
|
+
# engines/`engine_id``
|
1959
|
+
# Corresponds to the JSON property `engine`
|
1960
|
+
# @return [String]
|
1961
|
+
attr_accessor :engine
|
1962
|
+
|
1963
|
+
def initialize(**args)
|
1964
|
+
update!(**args)
|
1965
|
+
end
|
1966
|
+
|
1967
|
+
# Update properties of this object
|
1968
|
+
def update!(**args)
|
1969
|
+
@engine = args[:engine] if args.key?(:engine)
|
1970
|
+
end
|
1971
|
+
end
|
1972
|
+
|
1973
|
+
# Response associated with a tune operation.
|
1974
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
|
1975
|
+
include Google::Apis::Core::Hashable
|
1976
|
+
|
1977
|
+
def initialize(**args)
|
1978
|
+
update!(**args)
|
1979
|
+
end
|
1980
|
+
|
1981
|
+
# Update properties of this object
|
1982
|
+
def update!(**args)
|
1983
|
+
end
|
1984
|
+
end
|
1985
|
+
|
1400
1986
|
# Metadata for UpdateSchema LRO.
|
1401
1987
|
class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
|
1402
1988
|
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.27.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 = "20231102"
|
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,107 @@ 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 :media_recommendation_engine_config, as: 'mediaRecommendationEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig::Representation
|
1071
|
+
|
1072
|
+
property :name, as: 'name'
|
1073
|
+
property :recommendation_metadata, as: 'recommendationMetadata', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata::Representation
|
1074
|
+
|
1075
|
+
property :search_engine_config, as: 'searchEngineConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig::Representation
|
1076
|
+
|
1077
|
+
property :similar_documents_config, as: 'similarDocumentsConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig::Representation
|
1078
|
+
|
1079
|
+
property :solution_type, as: 'solutionType'
|
1080
|
+
property :update_time, as: 'updateTime'
|
1081
|
+
end
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
|
1085
|
+
# @private
|
1086
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1087
|
+
property :agent_creation_config, as: 'agentCreationConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig::Representation
|
1088
|
+
|
1089
|
+
property :dialogflow_agent_to_link, as: 'dialogflowAgentToLink'
|
1090
|
+
end
|
1091
|
+
end
|
1092
|
+
|
1093
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
|
1094
|
+
# @private
|
1095
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1096
|
+
property :business, as: 'business'
|
1097
|
+
property :default_language_code, as: 'defaultLanguageCode'
|
1098
|
+
property :time_zone, as: 'timeZone'
|
1099
|
+
end
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
|
1103
|
+
# @private
|
1104
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1105
|
+
property :dialogflow_agent, as: 'dialogflowAgent'
|
1106
|
+
end
|
1107
|
+
end
|
1108
|
+
|
1109
|
+
class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
|
1110
|
+
# @private
|
1111
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1112
|
+
property :company_name, as: 'companyName'
|
1113
|
+
end
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
1117
|
+
# @private
|
1118
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1119
|
+
property :optimization_objective, as: 'optimizationObjective'
|
1120
|
+
property :optimization_objective_config, as: 'optimizationObjectiveConfig', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig::Representation
|
1121
|
+
|
1122
|
+
property :training_state, as: 'trainingState'
|
1123
|
+
property :type, as: 'type'
|
1124
|
+
end
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
1128
|
+
# @private
|
1129
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1130
|
+
property :target_field, as: 'targetField'
|
1131
|
+
property :target_field_value_float, as: 'targetFieldValueFloat'
|
1132
|
+
end
|
1133
|
+
end
|
1134
|
+
|
1135
|
+
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
1136
|
+
# @private
|
1137
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1138
|
+
property :data_state, as: 'dataState'
|
1139
|
+
property :last_tune_time, as: 'lastTuneTime'
|
1140
|
+
property :serving_state, as: 'servingState'
|
1141
|
+
property :tuning_operation, as: 'tuningOperation'
|
1142
|
+
end
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
|
1146
|
+
# @private
|
1147
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1148
|
+
collection :search_add_ons, as: 'searchAddOns'
|
1149
|
+
property :search_tier, as: 'searchTier'
|
1150
|
+
end
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
|
1154
|
+
# @private
|
1155
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1156
|
+
end
|
1157
|
+
end
|
1158
|
+
|
911
1159
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
912
1160
|
# @private
|
913
1161
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1096,6 +1344,19 @@ module Google
|
|
1096
1344
|
end
|
1097
1345
|
end
|
1098
1346
|
|
1347
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
1348
|
+
# @private
|
1349
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1350
|
+
property :engine, as: 'engine'
|
1351
|
+
end
|
1352
|
+
end
|
1353
|
+
|
1354
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
|
1355
|
+
# @private
|
1356
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
1357
|
+
end
|
1358
|
+
end
|
1359
|
+
|
1099
1360
|
class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
|
1100
1361
|
# @private
|
1101
1362
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1087,10 +1087,14 @@ module Google
|
|
1087
1087
|
|
1088
1088
|
# Makes a recommendation, which requires a contextual user event.
|
1089
1089
|
# @param [String] serving_config
|
1090
|
-
# Required. Full resource name of
|
1091
|
-
# collections/*/
|
1092
|
-
#
|
1093
|
-
#
|
1090
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
1091
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
1092
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
1093
|
+
# created along with your recommendation engine creation. The engine ID will be
|
1094
|
+
# used as the ID of the default serving config. For example, for Engine `
|
1095
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
1096
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
1097
|
+
# engine` for your Recommend requests.
|
1094
1098
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
1095
1099
|
# @param [String] fields
|
1096
1100
|
# Selector specifying which fields to include in a partial response.
|
@@ -1124,9 +1128,11 @@ module Google
|
|
1124
1128
|
# Performs a search.
|
1125
1129
|
# @param [String] serving_config
|
1126
1130
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
1127
|
-
# locations/global/collections/default_collection/
|
1128
|
-
#
|
1129
|
-
#
|
1131
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1132
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1133
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
1134
|
+
# default_serving_config`. This field is used to identify the serving
|
1135
|
+
# configuration name, set of models used to make the search.
|
1130
1136
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
1131
1137
|
# @param [String] fields
|
1132
1138
|
# Selector specifying which fields to include in a partial response.
|
@@ -1492,10 +1498,14 @@ module Google
|
|
1492
1498
|
|
1493
1499
|
# Makes a recommendation, which requires a contextual user event.
|
1494
1500
|
# @param [String] serving_config
|
1495
|
-
# Required. Full resource name of
|
1496
|
-
# collections/*/
|
1497
|
-
#
|
1498
|
-
#
|
1501
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
1502
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
1503
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
1504
|
+
# created along with your recommendation engine creation. The engine ID will be
|
1505
|
+
# used as the ID of the default serving config. For example, for Engine `
|
1506
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
1507
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
1508
|
+
# engine` for your Recommend requests.
|
1499
1509
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
1500
1510
|
# @param [String] fields
|
1501
1511
|
# Selector specifying which fields to include in a partial response.
|
@@ -1529,9 +1539,11 @@ module Google
|
|
1529
1539
|
# Performs a search.
|
1530
1540
|
# @param [String] serving_config
|
1531
1541
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
1532
|
-
# locations/global/collections/default_collection/
|
1533
|
-
#
|
1534
|
-
#
|
1542
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1543
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1544
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
1545
|
+
# default_serving_config`. This field is used to identify the serving
|
1546
|
+
# configuration name, set of models used to make the search.
|
1535
1547
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
1536
1548
|
# @param [String] fields
|
1537
1549
|
# Selector specifying which fields to include in a partial response.
|
@@ -2600,10 +2612,14 @@ module Google
|
|
2600
2612
|
|
2601
2613
|
# Makes a recommendation, which requires a contextual user event.
|
2602
2614
|
# @param [String] serving_config
|
2603
|
-
# Required. Full resource name of
|
2604
|
-
# collections/*/
|
2605
|
-
#
|
2606
|
-
#
|
2615
|
+
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
2616
|
+
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
2617
|
+
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
2618
|
+
# created along with your recommendation engine creation. The engine ID will be
|
2619
|
+
# used as the ID of the default serving config. For example, for Engine `
|
2620
|
+
# projects/*/locations/global/collections/*/engines/my-engine`, you can use `
|
2621
|
+
# projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-
|
2622
|
+
# engine` for your Recommend requests.
|
2607
2623
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
2608
2624
|
# @param [String] fields
|
2609
2625
|
# Selector specifying which fields to include in a partial response.
|
@@ -2637,9 +2653,11 @@ module Google
|
|
2637
2653
|
# Performs a search.
|
2638
2654
|
# @param [String] serving_config
|
2639
2655
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
2640
|
-
# locations/global/collections/default_collection/
|
2641
|
-
#
|
2642
|
-
#
|
2656
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
2657
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
2658
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
2659
|
+
# default_serving_config`. This field is used to identify the serving
|
2660
|
+
# configuration name, set of models used to make the search.
|
2643
2661
|
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
2644
2662
|
# @param [String] fields
|
2645
2663
|
# 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.27.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-12 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.27.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: []
|