google-apis-discoveryengine_v1alpha 0.75.0 → 0.76.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.
@@ -1835,6 +1835,12 @@ module Google
1835
1835
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AssistantCustomerPolicyBannedPhrase>]
1836
1836
  attr_accessor :banned_phrases
1837
1837
 
1838
+ # Configuration for customer defined Model Armor templates to be used for
1839
+ # sanitizing user prompts and assistant responses.
1840
+ # Corresponds to the JSON property `modelArmorConfig`
1841
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig]
1842
+ attr_accessor :model_armor_config
1843
+
1838
1844
  def initialize(**args)
1839
1845
  update!(**args)
1840
1846
  end
@@ -1842,6 +1848,7 @@ module Google
1842
1848
  # Update properties of this object
1843
1849
  def update!(**args)
1844
1850
  @banned_phrases = args[:banned_phrases] if args.key?(:banned_phrases)
1851
+ @model_armor_config = args[:model_armor_config] if args.key?(:model_armor_config)
1845
1852
  end
1846
1853
  end
1847
1854
 
@@ -1880,6 +1887,44 @@ module Google
1880
1887
  end
1881
1888
  end
1882
1889
 
1890
+ # Configuration for customer defined Model Armor templates to be used for
1891
+ # sanitizing user prompts and assistant responses.
1892
+ class GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig
1893
+ include Google::Apis::Core::Hashable
1894
+
1895
+ # Optional. Defines the failure mode for Model Armor sanitization.
1896
+ # Corresponds to the JSON property `failureMode`
1897
+ # @return [String]
1898
+ attr_accessor :failure_mode
1899
+
1900
+ # Optional. The resource name of the Model Armor template for sanitizing
1901
+ # assistant responses. Format: `projects/`project`/locations/`location`/
1902
+ # templates/`template_id`` If not specified, no sanitization will be applied to
1903
+ # the assistant response.
1904
+ # Corresponds to the JSON property `responseTemplate`
1905
+ # @return [String]
1906
+ attr_accessor :response_template
1907
+
1908
+ # Optional. The resource name of the Model Armor template for sanitizing user
1909
+ # prompts. Format: `projects/`project`/locations/`location`/templates/`
1910
+ # template_id`` If not specified, no sanitization will be applied to the user
1911
+ # prompt.
1912
+ # Corresponds to the JSON property `userPromptTemplate`
1913
+ # @return [String]
1914
+ attr_accessor :user_prompt_template
1915
+
1916
+ def initialize(**args)
1917
+ update!(**args)
1918
+ end
1919
+
1920
+ # Update properties of this object
1921
+ def update!(**args)
1922
+ @failure_mode = args[:failure_mode] if args.key?(:failure_mode)
1923
+ @response_template = args[:response_template] if args.key?(:response_template)
1924
+ @user_prompt_template = args[:user_prompt_template] if args.key?(:user_prompt_template)
1925
+ end
1926
+ end
1927
+
1883
1928
  # Configuration for the generation of the assistant response.
1884
1929
  class GoogleCloudDiscoveryengineV1AssistantGenerationConfig
1885
1930
  include Google::Apis::Core::Hashable
@@ -8164,6 +8209,12 @@ module Google
8164
8209
  # @return [Array<String>]
8165
8210
  attr_accessor :assist_skipped_reasons
8166
8211
 
8212
+ # Customer policy enforcement results. Contains the results of the various
8213
+ # policy checks, like the banned phrases or the Model Armor checks.
8214
+ # Corresponds to the JSON property `customerPolicyEnforcementResult`
8215
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult]
8216
+ attr_accessor :customer_policy_enforcement_result
8217
+
8167
8218
  # Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/`
8168
8219
  # project`/locations/`location`/collections/`collection`/engines/`engine`/
8169
8220
  # sessions/`session`/assistAnswers/`assist_answer`` This field must be a UTF-8
@@ -8189,12 +8240,116 @@ module Google
8189
8240
  # Update properties of this object
8190
8241
  def update!(**args)
8191
8242
  @assist_skipped_reasons = args[:assist_skipped_reasons] if args.key?(:assist_skipped_reasons)
8243
+ @customer_policy_enforcement_result = args[:customer_policy_enforcement_result] if args.key?(:customer_policy_enforcement_result)
8192
8244
  @name = args[:name] if args.key?(:name)
8193
8245
  @replies = args[:replies] if args.key?(:replies)
8194
8246
  @state = args[:state] if args.key?(:state)
8195
8247
  end
8196
8248
  end
8197
8249
 
8250
+ # Customer policy enforcement results. Contains the results of the various
8251
+ # policy checks, like the banned phrases or the Model Armor checks.
8252
+ class GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResult
8253
+ include Google::Apis::Core::Hashable
8254
+
8255
+ # Customer policy enforcement results. Populated only if the assist call was
8256
+ # skipped due to a policy violation. It contains results from those filters that
8257
+ # blocked the processing of the query.
8258
+ # Corresponds to the JSON property `policyResults`
8259
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult>]
8260
+ attr_accessor :policy_results
8261
+
8262
+ # Final verdict of the customer policy enforcement. If only one policy blocked
8263
+ # the processing, the verdict is BLOCK.
8264
+ # Corresponds to the JSON property `verdict`
8265
+ # @return [String]
8266
+ attr_accessor :verdict
8267
+
8268
+ def initialize(**args)
8269
+ update!(**args)
8270
+ end
8271
+
8272
+ # Update properties of this object
8273
+ def update!(**args)
8274
+ @policy_results = args[:policy_results] if args.key?(:policy_results)
8275
+ @verdict = args[:verdict] if args.key?(:verdict)
8276
+ end
8277
+ end
8278
+
8279
+ # Customer policy enforcement result for the banned phrase policy.
8280
+ class GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult
8281
+ include Google::Apis::Core::Hashable
8282
+
8283
+ # The banned phrases that were found in the query or the answer.
8284
+ # Corresponds to the JSON property `bannedPhrases`
8285
+ # @return [Array<String>]
8286
+ attr_accessor :banned_phrases
8287
+
8288
+ def initialize(**args)
8289
+ update!(**args)
8290
+ end
8291
+
8292
+ # Update properties of this object
8293
+ def update!(**args)
8294
+ @banned_phrases = args[:banned_phrases] if args.key?(:banned_phrases)
8295
+ end
8296
+ end
8297
+
8298
+ # Customer policy enforcement result for the Model Armor policy.
8299
+ class GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult
8300
+ include Google::Apis::Core::Hashable
8301
+
8302
+ # The `Status` type defines a logical error model that is suitable for different
8303
+ # programming environments, including REST APIs and RPC APIs. It is used by [
8304
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
8305
+ # data: error code, error message, and error details. You can find out more
8306
+ # about this error model and how to work with it in the [API Design Guide](https:
8307
+ # //cloud.google.com/apis/design/errors).
8308
+ # Corresponds to the JSON property `error`
8309
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus]
8310
+ attr_accessor :error
8311
+
8312
+ # The Model Armor violation that was found.
8313
+ # Corresponds to the JSON property `modelArmorViolation`
8314
+ # @return [String]
8315
+ attr_accessor :model_armor_violation
8316
+
8317
+ def initialize(**args)
8318
+ update!(**args)
8319
+ end
8320
+
8321
+ # Update properties of this object
8322
+ def update!(**args)
8323
+ @error = args[:error] if args.key?(:error)
8324
+ @model_armor_violation = args[:model_armor_violation] if args.key?(:model_armor_violation)
8325
+ end
8326
+ end
8327
+
8328
+ # Customer policy enforcement result for a single policy type.
8329
+ class GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultPolicyEnforcementResult
8330
+ include Google::Apis::Core::Hashable
8331
+
8332
+ # Customer policy enforcement result for the banned phrase policy.
8333
+ # Corresponds to the JSON property `bannedPhraseEnforcementResult`
8334
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultBannedPhraseEnforcementResult]
8335
+ attr_accessor :banned_phrase_enforcement_result
8336
+
8337
+ # Customer policy enforcement result for the Model Armor policy.
8338
+ # Corresponds to the JSON property `modelArmorEnforcementResult`
8339
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistAnswerCustomerPolicyEnforcementResultModelArmorEnforcementResult]
8340
+ attr_accessor :model_armor_enforcement_result
8341
+
8342
+ def initialize(**args)
8343
+ update!(**args)
8344
+ end
8345
+
8346
+ # Update properties of this object
8347
+ def update!(**args)
8348
+ @banned_phrase_enforcement_result = args[:banned_phrase_enforcement_result] if args.key?(:banned_phrase_enforcement_result)
8349
+ @model_armor_enforcement_result = args[:model_armor_enforcement_result] if args.key?(:model_armor_enforcement_result)
8350
+ end
8351
+ end
8352
+
8198
8353
  # One part of the multi-part response of the assist call.
8199
8354
  class GoogleCloudDiscoveryengineV1alphaAssistAnswerReply
8200
8355
  include Google::Apis::Core::Hashable
@@ -8457,6 +8612,12 @@ module Google
8457
8612
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyBannedPhrase>]
8458
8613
  attr_accessor :banned_phrases
8459
8614
 
8615
+ # Configuration for customer defined Model Armor templates to be used for
8616
+ # sanitizing user prompts and assistant responses.
8617
+ # Corresponds to the JSON property `modelArmorConfig`
8618
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig]
8619
+ attr_accessor :model_armor_config
8620
+
8460
8621
  def initialize(**args)
8461
8622
  update!(**args)
8462
8623
  end
@@ -8464,6 +8625,7 @@ module Google
8464
8625
  # Update properties of this object
8465
8626
  def update!(**args)
8466
8627
  @banned_phrases = args[:banned_phrases] if args.key?(:banned_phrases)
8628
+ @model_armor_config = args[:model_armor_config] if args.key?(:model_armor_config)
8467
8629
  end
8468
8630
  end
8469
8631
 
@@ -8502,6 +8664,44 @@ module Google
8502
8664
  end
8503
8665
  end
8504
8666
 
8667
+ # Configuration for customer defined Model Armor templates to be used for
8668
+ # sanitizing user prompts and assistant responses.
8669
+ class GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig
8670
+ include Google::Apis::Core::Hashable
8671
+
8672
+ # Optional. Defines the failure mode for Model Armor sanitization.
8673
+ # Corresponds to the JSON property `failureMode`
8674
+ # @return [String]
8675
+ attr_accessor :failure_mode
8676
+
8677
+ # Optional. The resource name of the Model Armor template for sanitizing
8678
+ # assistant responses. Format: `projects/`project`/locations/`location`/
8679
+ # templates/`template_id`` If not specified, no sanitization will be applied to
8680
+ # the assistant response.
8681
+ # Corresponds to the JSON property `responseTemplate`
8682
+ # @return [String]
8683
+ attr_accessor :response_template
8684
+
8685
+ # Optional. The resource name of the Model Armor template for sanitizing user
8686
+ # prompts. Format: `projects/`project`/locations/`location`/templates/`
8687
+ # template_id`` If not specified, no sanitization will be applied to the user
8688
+ # prompt.
8689
+ # Corresponds to the JSON property `userPromptTemplate`
8690
+ # @return [String]
8691
+ attr_accessor :user_prompt_template
8692
+
8693
+ def initialize(**args)
8694
+ update!(**args)
8695
+ end
8696
+
8697
+ # Update properties of this object
8698
+ def update!(**args)
8699
+ @failure_mode = args[:failure_mode] if args.key?(:failure_mode)
8700
+ @response_template = args[:response_template] if args.key?(:response_template)
8701
+ @user_prompt_template = args[:user_prompt_template] if args.key?(:user_prompt_template)
8702
+ end
8703
+ end
8704
+
8505
8705
  # Configuration for the generation of the assistant response.
8506
8706
  class GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig
8507
8707
  include Google::Apis::Core::Hashable
@@ -11483,6 +11683,12 @@ module Google
11483
11683
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
11484
11684
  attr_accessor :errors
11485
11685
 
11686
+ # Any params and credentials used specifically for hybrid connectors supporting
11687
+ # FEDERATED mode.
11688
+ # Corresponds to the JSON property `federatedConfig`
11689
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig]
11690
+ attr_accessor :federated_config
11691
+
11486
11692
  # Optional. If the connector is a hybrid connector, determines whether ingestion
11487
11693
  # is enabled and appropriate resources are provisioned during connector creation.
11488
11694
  # If the connector is not a hybrid connector, this field is ignored.
@@ -11622,6 +11828,14 @@ module Google
11622
11828
  # @return [String]
11623
11829
  attr_accessor :refresh_interval
11624
11830
 
11831
+ # Optional. Specifies keys to be removed from the 'params' field. This is only
11832
+ # active when 'params' is included in the 'update_mask' in an
11833
+ # UpdateDataConnectorRequest. Deletion takes precedence if a key is both in '
11834
+ # remove_param_keys' and present in the 'params' field of the request.
11835
+ # Corresponds to the JSON property `removeParamKeys`
11836
+ # @return [Array<String>]
11837
+ attr_accessor :remove_param_keys
11838
+
11625
11839
  # Output only. State of the connector.
11626
11840
  # Corresponds to the JSON property `state`
11627
11841
  # @return [String]
@@ -11670,6 +11884,7 @@ module Google
11670
11884
  @end_user_config = args[:end_user_config] if args.key?(:end_user_config)
11671
11885
  @entities = args[:entities] if args.key?(:entities)
11672
11886
  @errors = args[:errors] if args.key?(:errors)
11887
+ @federated_config = args[:federated_config] if args.key?(:federated_config)
11673
11888
  @hybrid_ingestion_disabled = args[:hybrid_ingestion_disabled] if args.key?(:hybrid_ingestion_disabled)
11674
11889
  @identity_refresh_interval = args[:identity_refresh_interval] if args.key?(:identity_refresh_interval)
11675
11890
  @identity_schedule_config = args[:identity_schedule_config] if args.key?(:identity_schedule_config)
@@ -11685,6 +11900,7 @@ module Google
11685
11900
  @realtime_state = args[:realtime_state] if args.key?(:realtime_state)
11686
11901
  @realtime_sync_config = args[:realtime_sync_config] if args.key?(:realtime_sync_config)
11687
11902
  @refresh_interval = args[:refresh_interval] if args.key?(:refresh_interval)
11903
+ @remove_param_keys = args[:remove_param_keys] if args.key?(:remove_param_keys)
11688
11904
  @state = args[:state] if args.key?(:state)
11689
11905
  @static_ip_addresses = args[:static_ip_addresses] if args.key?(:static_ip_addresses)
11690
11906
  @static_ip_enabled = args[:static_ip_enabled] if args.key?(:static_ip_enabled)
@@ -11726,6 +11942,32 @@ module Google
11726
11942
  end
11727
11943
  end
11728
11944
 
11945
+ # Any params and credentials used specifically for hybrid connectors supporting
11946
+ # FEDERATED mode.
11947
+ class GoogleCloudDiscoveryengineV1alphaDataConnectorFederatedConfig
11948
+ include Google::Apis::Core::Hashable
11949
+
11950
+ # Optional. Any additional parameters needed for FEDERATED.
11951
+ # Corresponds to the JSON property `additionalParams`
11952
+ # @return [Hash<String,Object>]
11953
+ attr_accessor :additional_params
11954
+
11955
+ # Optional. Any authentication parameters specific to FEDERATED.
11956
+ # Corresponds to the JSON property `authParams`
11957
+ # @return [Hash<String,Object>]
11958
+ attr_accessor :auth_params
11959
+
11960
+ def initialize(**args)
11961
+ update!(**args)
11962
+ end
11963
+
11964
+ # Update properties of this object
11965
+ def update!(**args)
11966
+ @additional_params = args[:additional_params] if args.key?(:additional_params)
11967
+ @auth_params = args[:auth_params] if args.key?(:auth_params)
11968
+ end
11969
+ end
11970
+
11729
11971
  # The configuration for realtime sync to store additional params for realtime
11730
11972
  # sync.
11731
11973
  class GoogleCloudDiscoveryengineV1alphaDataConnectorRealtimeSyncConfig
@@ -23763,6 +24005,12 @@ module Google
23763
24005
  attr_accessor :default_web_grounding_toggle_off
23764
24006
  alias_method :default_web_grounding_toggle_off?, :default_web_grounding_toggle_off
23765
24007
 
24008
+ # Optional. Output only. Whether to disable user location context.
24009
+ # Corresponds to the JSON property `disableLocationContext`
24010
+ # @return [Boolean]
24011
+ attr_accessor :disable_location_context
24012
+ alias_method :disable_location_context?, :disable_location_context
24013
+
23766
24014
  # Whether or not the Google search grounding toggle is shown. Deprecated. Use
23767
24015
  # web_grounding_type instead.
23768
24016
  # Corresponds to the JSON property `googleSearchGroundingEnabled`
@@ -23782,6 +24030,7 @@ module Google
23782
24030
  # Update properties of this object
23783
24031
  def update!(**args)
23784
24032
  @default_web_grounding_toggle_off = args[:default_web_grounding_toggle_off] if args.key?(:default_web_grounding_toggle_off)
24033
+ @disable_location_context = args[:disable_location_context] if args.key?(:disable_location_context)
23785
24034
  @google_search_grounding_enabled = args[:google_search_grounding_enabled] if args.key?(:google_search_grounding_enabled)
23786
24035
  @web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
23787
24036
  end
@@ -23878,6 +24127,11 @@ module Google
23878
24127
  # @return [String]
23879
24128
  attr_accessor :content_config
23880
24129
 
24130
+ # Output only. The type of the data store config.
24131
+ # Corresponds to the JSON property `dataStoreConfigType`
24132
+ # @return [String]
24133
+ attr_accessor :data_store_config_type
24134
+
23881
24135
  # The display name of the data store.
23882
24136
  # Corresponds to the JSON property `displayName`
23883
24137
  # @return [String]
@@ -23918,6 +24172,7 @@ module Google
23918
24172
  # Update properties of this object
23919
24173
  def update!(**args)
23920
24174
  @content_config = args[:content_config] if args.key?(:content_config)
24175
+ @data_store_config_type = args[:data_store_config_type] if args.key?(:data_store_config_type)
23921
24176
  @display_name = args[:display_name] if args.key?(:display_name)
23922
24177
  @entity_name = args[:entity_name] if args.key?(:entity_name)
23923
24178
  @id = args[:id] if args.key?(:id)
@@ -29598,8 +29853,7 @@ module Google
29598
29853
  attr_accessor :audio_overview_id
29599
29854
 
29600
29855
  # The language code of the generated audio overview. Use the BCP 47 language
29601
- # code (e.g. "en", "es", "hi", etc.). Examples: google3/i18n/identifiers/tools/
29602
- # language_code_constants.txt
29856
+ # code (e.g. "en", "es", "hi", etc.).
29603
29857
  # Corresponds to the JSON property `languageCode`
29604
29858
  # @return [String]
29605
29859
  attr_accessor :language_code
@@ -29811,6 +30065,368 @@ module Google
29811
30065
  end
29812
30066
  end
29813
30067
 
30068
+ # Failure reason containing details about why a source failed to ingest.
30069
+ class GoogleCloudNotebooklmV1alphaFailureReason
30070
+ include Google::Apis::Core::Hashable
30071
+
30072
+ # An audio file transcription specific error.
30073
+ # Corresponds to the JSON property `audioTranscriptionError`
30074
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError]
30075
+ attr_accessor :audio_transcription_error
30076
+
30077
+ # Error to indicate that the source was removed because the domain was blocked.
30078
+ # Corresponds to the JSON property `domainBlocked`
30079
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked]
30080
+ attr_accessor :domain_blocked
30081
+
30082
+ # A google drive specific error.
30083
+ # Corresponds to the JSON property `googleDriveError`
30084
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError]
30085
+ attr_accessor :google_drive_error
30086
+
30087
+ # Indicates an error occurred while ingesting the source.
30088
+ # Corresponds to the JSON property `ingestionError`
30089
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonIngestionError]
30090
+ attr_accessor :ingestion_error
30091
+
30092
+ # Indicates that the source is paywalled and cannot be ingested.
30093
+ # Corresponds to the JSON property `paywallError`
30094
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonPaywallError]
30095
+ attr_accessor :paywall_error
30096
+
30097
+ # Indicates that the source is empty.
30098
+ # Corresponds to the JSON property `sourceEmpty`
30099
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty]
30100
+ attr_accessor :source_empty
30101
+
30102
+ # Indicates that the user does not have space for this source.
30103
+ # Corresponds to the JSON property `sourceLimitExceeded`
30104
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded]
30105
+ attr_accessor :source_limit_exceeded
30106
+
30107
+ # Indicates source word count exceeded the user's limit.
30108
+ # Corresponds to the JSON property `sourceTooLong`
30109
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong]
30110
+ attr_accessor :source_too_long
30111
+
30112
+ # Indicates that the source is unreachable. This is primarily used for sources
30113
+ # that are added via URL.
30114
+ # Corresponds to the JSON property `sourceUnreachable`
30115
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable]
30116
+ attr_accessor :source_unreachable
30117
+
30118
+ # Indicates an unknown error occurred.
30119
+ # Corresponds to the JSON property `unknown`
30120
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonUnknown]
30121
+ attr_accessor :unknown
30122
+
30123
+ # Indicates an error occurred while uploading the source.
30124
+ # Corresponds to the JSON property `uploadError`
30125
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonUploadError]
30126
+ attr_accessor :upload_error
30127
+
30128
+ # A youtube specific error.
30129
+ # Corresponds to the JSON property `youtubeError`
30130
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError]
30131
+ attr_accessor :youtube_error
30132
+
30133
+ def initialize(**args)
30134
+ update!(**args)
30135
+ end
30136
+
30137
+ # Update properties of this object
30138
+ def update!(**args)
30139
+ @audio_transcription_error = args[:audio_transcription_error] if args.key?(:audio_transcription_error)
30140
+ @domain_blocked = args[:domain_blocked] if args.key?(:domain_blocked)
30141
+ @google_drive_error = args[:google_drive_error] if args.key?(:google_drive_error)
30142
+ @ingestion_error = args[:ingestion_error] if args.key?(:ingestion_error)
30143
+ @paywall_error = args[:paywall_error] if args.key?(:paywall_error)
30144
+ @source_empty = args[:source_empty] if args.key?(:source_empty)
30145
+ @source_limit_exceeded = args[:source_limit_exceeded] if args.key?(:source_limit_exceeded)
30146
+ @source_too_long = args[:source_too_long] if args.key?(:source_too_long)
30147
+ @source_unreachable = args[:source_unreachable] if args.key?(:source_unreachable)
30148
+ @unknown = args[:unknown] if args.key?(:unknown)
30149
+ @upload_error = args[:upload_error] if args.key?(:upload_error)
30150
+ @youtube_error = args[:youtube_error] if args.key?(:youtube_error)
30151
+ end
30152
+ end
30153
+
30154
+ # An audio file transcription specific error.
30155
+ class GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError
30156
+ include Google::Apis::Core::Hashable
30157
+
30158
+ # Could not detect language of the file (it may not be speech).
30159
+ # Corresponds to the JSON property `languageDetectionFailed`
30160
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed]
30161
+ attr_accessor :language_detection_failed
30162
+
30163
+ # No audio was detected in the input file.
30164
+ # Corresponds to the JSON property `noAudioDetected`
30165
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected]
30166
+ attr_accessor :no_audio_detected
30167
+
30168
+ def initialize(**args)
30169
+ update!(**args)
30170
+ end
30171
+
30172
+ # Update properties of this object
30173
+ def update!(**args)
30174
+ @language_detection_failed = args[:language_detection_failed] if args.key?(:language_detection_failed)
30175
+ @no_audio_detected = args[:no_audio_detected] if args.key?(:no_audio_detected)
30176
+ end
30177
+ end
30178
+
30179
+ # Could not detect language of the file (it may not be speech).
30180
+ class GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed
30181
+ include Google::Apis::Core::Hashable
30182
+
30183
+ def initialize(**args)
30184
+ update!(**args)
30185
+ end
30186
+
30187
+ # Update properties of this object
30188
+ def update!(**args)
30189
+ end
30190
+ end
30191
+
30192
+ # No audio was detected in the input file.
30193
+ class GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected
30194
+ include Google::Apis::Core::Hashable
30195
+
30196
+ def initialize(**args)
30197
+ update!(**args)
30198
+ end
30199
+
30200
+ # Update properties of this object
30201
+ def update!(**args)
30202
+ end
30203
+ end
30204
+
30205
+ # Error to indicate that the source was removed because the domain was blocked.
30206
+ class GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked
30207
+ include Google::Apis::Core::Hashable
30208
+
30209
+ def initialize(**args)
30210
+ update!(**args)
30211
+ end
30212
+
30213
+ # Update properties of this object
30214
+ def update!(**args)
30215
+ end
30216
+ end
30217
+
30218
+ # A google drive specific error.
30219
+ class GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError
30220
+ include Google::Apis::Core::Hashable
30221
+
30222
+ # The user was prevented from downloading the file.
30223
+ # Corresponds to the JSON property `downloadPrevented`
30224
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented]
30225
+ attr_accessor :download_prevented
30226
+
30227
+ def initialize(**args)
30228
+ update!(**args)
30229
+ end
30230
+
30231
+ # Update properties of this object
30232
+ def update!(**args)
30233
+ @download_prevented = args[:download_prevented] if args.key?(:download_prevented)
30234
+ end
30235
+ end
30236
+
30237
+ # The user was prevented from downloading the file.
30238
+ class GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented
30239
+ include Google::Apis::Core::Hashable
30240
+
30241
+ def initialize(**args)
30242
+ update!(**args)
30243
+ end
30244
+
30245
+ # Update properties of this object
30246
+ def update!(**args)
30247
+ end
30248
+ end
30249
+
30250
+ # Indicates an error occurred while ingesting the source.
30251
+ class GoogleCloudNotebooklmV1alphaFailureReasonIngestionError
30252
+ include Google::Apis::Core::Hashable
30253
+
30254
+ def initialize(**args)
30255
+ update!(**args)
30256
+ end
30257
+
30258
+ # Update properties of this object
30259
+ def update!(**args)
30260
+ end
30261
+ end
30262
+
30263
+ # Indicates that the source is paywalled and cannot be ingested.
30264
+ class GoogleCloudNotebooklmV1alphaFailureReasonPaywallError
30265
+ include Google::Apis::Core::Hashable
30266
+
30267
+ def initialize(**args)
30268
+ update!(**args)
30269
+ end
30270
+
30271
+ # Update properties of this object
30272
+ def update!(**args)
30273
+ end
30274
+ end
30275
+
30276
+ # Indicates that the source is empty.
30277
+ class GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty
30278
+ include Google::Apis::Core::Hashable
30279
+
30280
+ def initialize(**args)
30281
+ update!(**args)
30282
+ end
30283
+
30284
+ # Update properties of this object
30285
+ def update!(**args)
30286
+ end
30287
+ end
30288
+
30289
+ # Indicates that the user does not have space for this source.
30290
+ class GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded
30291
+ include Google::Apis::Core::Hashable
30292
+
30293
+ def initialize(**args)
30294
+ update!(**args)
30295
+ end
30296
+
30297
+ # Update properties of this object
30298
+ def update!(**args)
30299
+ end
30300
+ end
30301
+
30302
+ # Indicates source word count exceeded the user's limit.
30303
+ class GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong
30304
+ include Google::Apis::Core::Hashable
30305
+
30306
+ # The number of words in the source.
30307
+ # Corresponds to the JSON property `wordCount`
30308
+ # @return [Fixnum]
30309
+ attr_accessor :word_count
30310
+
30311
+ # The word count limit for the current user at the time of the upload.
30312
+ # Corresponds to the JSON property `wordLimit`
30313
+ # @return [Fixnum]
30314
+ attr_accessor :word_limit
30315
+
30316
+ def initialize(**args)
30317
+ update!(**args)
30318
+ end
30319
+
30320
+ # Update properties of this object
30321
+ def update!(**args)
30322
+ @word_count = args[:word_count] if args.key?(:word_count)
30323
+ @word_limit = args[:word_limit] if args.key?(:word_limit)
30324
+ end
30325
+ end
30326
+
30327
+ # Indicates that the source is unreachable. This is primarily used for sources
30328
+ # that are added via URL.
30329
+ class GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable
30330
+ include Google::Apis::Core::Hashable
30331
+
30332
+ # Describes why the source is unreachable.
30333
+ # Corresponds to the JSON property `errorDetails`
30334
+ # @return [String]
30335
+ attr_accessor :error_details
30336
+
30337
+ def initialize(**args)
30338
+ update!(**args)
30339
+ end
30340
+
30341
+ # Update properties of this object
30342
+ def update!(**args)
30343
+ @error_details = args[:error_details] if args.key?(:error_details)
30344
+ end
30345
+ end
30346
+
30347
+ # Indicates an unknown error occurred.
30348
+ class GoogleCloudNotebooklmV1alphaFailureReasonUnknown
30349
+ include Google::Apis::Core::Hashable
30350
+
30351
+ def initialize(**args)
30352
+ update!(**args)
30353
+ end
30354
+
30355
+ # Update properties of this object
30356
+ def update!(**args)
30357
+ end
30358
+ end
30359
+
30360
+ # Indicates an error occurred while uploading the source.
30361
+ class GoogleCloudNotebooklmV1alphaFailureReasonUploadError
30362
+ include Google::Apis::Core::Hashable
30363
+
30364
+ def initialize(**args)
30365
+ update!(**args)
30366
+ end
30367
+
30368
+ # Update properties of this object
30369
+ def update!(**args)
30370
+ end
30371
+ end
30372
+
30373
+ # A youtube specific error.
30374
+ class GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError
30375
+ include Google::Apis::Core::Hashable
30376
+
30377
+ # Error to indicate that the source was removed because the video was deleted.
30378
+ # Corresponds to the JSON property `videoDeleted`
30379
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted]
30380
+ attr_accessor :video_deleted
30381
+
30382
+ def initialize(**args)
30383
+ update!(**args)
30384
+ end
30385
+
30386
+ # Update properties of this object
30387
+ def update!(**args)
30388
+ @video_deleted = args[:video_deleted] if args.key?(:video_deleted)
30389
+ end
30390
+ end
30391
+
30392
+ # Error to indicate that the source was removed because the video was deleted.
30393
+ class GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted
30394
+ include Google::Apis::Core::Hashable
30395
+
30396
+ def initialize(**args)
30397
+ update!(**args)
30398
+ end
30399
+
30400
+ # Update properties of this object
30401
+ def update!(**args)
30402
+ end
30403
+ end
30404
+
30405
+ # Metadata about a google doc source.
30406
+ class GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata
30407
+ include Google::Apis::Core::Hashable
30408
+
30409
+ # Output only. The document id of the google doc.
30410
+ # Corresponds to the JSON property `documentId`
30411
+ # @return [String]
30412
+ attr_accessor :document_id
30413
+
30414
+ # Output only. Revision id for the doc.
30415
+ # Corresponds to the JSON property `revisionId`
30416
+ # @return [String]
30417
+ attr_accessor :revision_id
30418
+
30419
+ def initialize(**args)
30420
+ update!(**args)
30421
+ end
30422
+
30423
+ # Update properties of this object
30424
+ def update!(**args)
30425
+ @document_id = args[:document_id] if args.key?(:document_id)
30426
+ @revision_id = args[:revision_id] if args.key?(:revision_id)
30427
+ end
30428
+ end
30429
+
29814
30430
  # Response for NotebookService.ListRecentlyViewedNotebooks method.
29815
30431
  class GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse
29816
30432
  include Google::Apis::Core::Hashable
@@ -29863,12 +30479,17 @@ module Google
29863
30479
  # @return [String]
29864
30480
  attr_accessor :name
29865
30481
 
29866
- # Optional. Notebook id, which is the last segment of the notebook's resource
29867
- # name. This is to make it similar with notebooklm API.
30482
+ # Output only. Notebook id, which is the last segment of the notebook's resource
30483
+ # name.
29868
30484
  # Corresponds to the JSON property `notebookId`
29869
30485
  # @return [String]
29870
30486
  attr_accessor :notebook_id
29871
30487
 
30488
+ # Output only. List of sources in the notebook. This is an output only field.
30489
+ # Corresponds to the JSON property `sources`
30490
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaSource>]
30491
+ attr_accessor :sources
30492
+
29872
30493
  # Optional. The title of the notebook.
29873
30494
  # Corresponds to the JSON property `title`
29874
30495
  # @return [String]
@@ -29885,6 +30506,7 @@ module Google
29885
30506
  @metadata = args[:metadata] if args.key?(:metadata)
29886
30507
  @name = args[:name] if args.key?(:name)
29887
30508
  @notebook_id = args[:notebook_id] if args.key?(:notebook_id)
30509
+ @sources = args[:sources] if args.key?(:sources)
29888
30510
  @title = args[:title] if args.key?(:title)
29889
30511
  end
29890
30512
  end
@@ -29984,6 +30606,12 @@ module Google
29984
30606
  # @return [String]
29985
30607
  attr_accessor :name
29986
30608
 
30609
+ # Allows extension of Source Settings in the BatchCreateSources (Formerly
30610
+ # AddSource request).
30611
+ # Corresponds to the JSON property `settings`
30612
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaSourceSettings]
30613
+ attr_accessor :settings
30614
+
29987
30615
  # SourceId is the last segment of the source's resource name.
29988
30616
  # Corresponds to the JSON property `sourceId`
29989
30617
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaSourceId]
@@ -30002,6 +30630,7 @@ module Google
30002
30630
  def update!(**args)
30003
30631
  @metadata = args[:metadata] if args.key?(:metadata)
30004
30632
  @name = args[:name] if args.key?(:name)
30633
+ @settings = args[:settings] if args.key?(:settings)
30005
30634
  @source_id = args[:source_id] if args.key?(:source_id)
30006
30635
  @title = args[:title] if args.key?(:title)
30007
30636
  end
@@ -30035,6 +30664,11 @@ module Google
30035
30664
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaAgentspaceMetadata]
30036
30665
  attr_accessor :agentspace_metadata
30037
30666
 
30667
+ # Metadata about a google doc source.
30668
+ # Corresponds to the JSON property `googleDocsMetadata`
30669
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata]
30670
+ attr_accessor :google_docs_metadata
30671
+
30038
30672
  # The timestamp the source was added.
30039
30673
  # Corresponds to the JSON property `sourceAddedTimestamp`
30040
30674
  # @return [String]
@@ -30050,6 +30684,11 @@ module Google
30050
30684
  # @return [Fixnum]
30051
30685
  attr_accessor :word_count
30052
30686
 
30687
+ # Metadata about a youtube video source.
30688
+ # Corresponds to the JSON property `youtubeMetadata`
30689
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaYoutubeMetadata]
30690
+ attr_accessor :youtube_metadata
30691
+
30053
30692
  def initialize(**args)
30054
30693
  update!(**args)
30055
30694
  end
@@ -30057,9 +30696,37 @@ module Google
30057
30696
  # Update properties of this object
30058
30697
  def update!(**args)
30059
30698
  @agentspace_metadata = args[:agentspace_metadata] if args.key?(:agentspace_metadata)
30699
+ @google_docs_metadata = args[:google_docs_metadata] if args.key?(:google_docs_metadata)
30060
30700
  @source_added_timestamp = args[:source_added_timestamp] if args.key?(:source_added_timestamp)
30061
30701
  @token_count = args[:token_count] if args.key?(:token_count)
30062
30702
  @word_count = args[:word_count] if args.key?(:word_count)
30703
+ @youtube_metadata = args[:youtube_metadata] if args.key?(:youtube_metadata)
30704
+ end
30705
+ end
30706
+
30707
+ # Allows extension of Source Settings in the BatchCreateSources (Formerly
30708
+ # AddSource request).
30709
+ class GoogleCloudNotebooklmV1alphaSourceSettings
30710
+ include Google::Apis::Core::Hashable
30711
+
30712
+ # Failure reason containing details about why a source failed to ingest.
30713
+ # Corresponds to the JSON property `failureReason`
30714
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudNotebooklmV1alphaFailureReason]
30715
+ attr_accessor :failure_reason
30716
+
30717
+ # Status of the source.
30718
+ # Corresponds to the JSON property `status`
30719
+ # @return [String]
30720
+ attr_accessor :status
30721
+
30722
+ def initialize(**args)
30723
+ update!(**args)
30724
+ end
30725
+
30726
+ # Update properties of this object
30727
+ def update!(**args)
30728
+ @failure_reason = args[:failure_reason] if args.key?(:failure_reason)
30729
+ @status = args[:status] if args.key?(:status)
30063
30730
  end
30064
30731
  end
30065
30732
 
@@ -30211,12 +30878,14 @@ module Google
30211
30878
  attr_accessor :document_id
30212
30879
 
30213
30880
  # The mime type of the selected document. This can be used to differentiate type
30214
- # of content selected in the drive picker.
30881
+ # of content selected in the drive picker. Use application/vnd.google-apps.
30882
+ # document for Google Docs or application/vnd.google-apps.presentation for
30883
+ # Google Slides.
30215
30884
  # Corresponds to the JSON property `mimeType`
30216
30885
  # @return [String]
30217
30886
  attr_accessor :mime_type
30218
30887
 
30219
- # Should track this from Drive Picker.
30888
+ # The name to be displayed for the source.
30220
30889
  # Corresponds to the JSON property `sourceName`
30221
30890
  # @return [String]
30222
30891
  attr_accessor :source_name
@@ -30237,12 +30906,12 @@ module Google
30237
30906
  class GoogleCloudNotebooklmV1alphaUserContentTextContent
30238
30907
  include Google::Apis::Core::Hashable
30239
30908
 
30240
- # The content of the text source.
30909
+ # The name to be displayed for the source.
30241
30910
  # Corresponds to the JSON property `content`
30242
30911
  # @return [String]
30243
30912
  attr_accessor :content
30244
30913
 
30245
- # The name of the text source.
30914
+ # The display name of the text source.
30246
30915
  # Corresponds to the JSON property `sourceName`
30247
30916
  # @return [String]
30248
30917
  attr_accessor :source_name
@@ -30281,7 +30950,7 @@ module Google
30281
30950
  class GoogleCloudNotebooklmV1alphaUserContentWebContent
30282
30951
  include Google::Apis::Core::Hashable
30283
30952
 
30284
- # The name of the web source.
30953
+ # The name to be displayed for the source.
30285
30954
  # Corresponds to the JSON property `sourceName`
30286
30955
  # @return [String]
30287
30956
  attr_accessor :source_name
@@ -30302,6 +30971,31 @@ module Google
30302
30971
  end
30303
30972
  end
30304
30973
 
30974
+ # Metadata about a youtube video source.
30975
+ class GoogleCloudNotebooklmV1alphaYoutubeMetadata
30976
+ include Google::Apis::Core::Hashable
30977
+
30978
+ # Output only. The channel name of the youtube video.
30979
+ # Corresponds to the JSON property `channelName`
30980
+ # @return [String]
30981
+ attr_accessor :channel_name
30982
+
30983
+ # Output only. The id of the youtube video.
30984
+ # Corresponds to the JSON property `videoId`
30985
+ # @return [String]
30986
+ attr_accessor :video_id
30987
+
30988
+ def initialize(**args)
30989
+ update!(**args)
30990
+ end
30991
+
30992
+ # Update properties of this object
30993
+ def update!(**args)
30994
+ @channel_name = args[:channel_name] if args.key?(:channel_name)
30995
+ @video_id = args[:video_id] if args.key?(:video_id)
30996
+ end
30997
+ end
30998
+
30305
30999
  # The request message for Operations.CancelOperation.
30306
31000
  class GoogleLongrunningCancelOperationRequest
30307
31001
  include Google::Apis::Core::Hashable