aws-sdk-connectwisdomservice 1.0.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.
@@ -0,0 +1,1942 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:connectwisdomservice)
34
+
35
+ module Aws::ConnectWisdomService
36
+ # An API client for ConnectWisdomService. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::ConnectWisdomService::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :connectwisdomservice
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Creates an Amazon Connect Wisdom assistant.
331
+ #
332
+ # @option params [String] :client_token
333
+ # A unique, case-sensitive identifier that you provide to ensure the
334
+ # idempotency of the request.
335
+ #
336
+ # **A suitable default value is auto-generated.** You should normally
337
+ # not need to pass this option.**
338
+ #
339
+ # @option params [String] :description
340
+ # The description of the assistant.
341
+ #
342
+ # @option params [required, String] :name
343
+ # The name of the assistant.
344
+ #
345
+ # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
346
+ # The KMS key used for encryption.
347
+ #
348
+ # @option params [Hash<String,String>] :tags
349
+ # The tags used to organize, track, or control access for this resource.
350
+ #
351
+ # @option params [required, String] :type
352
+ # The type of assistant.
353
+ #
354
+ # @return [Types::CreateAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
355
+ #
356
+ # * {Types::CreateAssistantResponse#assistant #assistant} => Types::AssistantData
357
+ #
358
+ # @example Request syntax with placeholder values
359
+ #
360
+ # resp = client.create_assistant({
361
+ # client_token: "ClientToken",
362
+ # description: "Description",
363
+ # name: "Name", # required
364
+ # server_side_encryption_configuration: {
365
+ # kms_key_id: "NonEmptyString",
366
+ # },
367
+ # tags: {
368
+ # "TagKey" => "TagValue",
369
+ # },
370
+ # type: "AGENT", # required, accepts AGENT
371
+ # })
372
+ #
373
+ # @example Response structure
374
+ #
375
+ # resp.assistant.assistant_arn #=> String
376
+ # resp.assistant.assistant_id #=> String
377
+ # resp.assistant.description #=> String
378
+ # resp.assistant.name #=> String
379
+ # resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
380
+ # resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
381
+ # resp.assistant.tags #=> Hash
382
+ # resp.assistant.tags["TagKey"] #=> String
383
+ # resp.assistant.type #=> String, one of "AGENT"
384
+ #
385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistant AWS API Documentation
386
+ #
387
+ # @overload create_assistant(params = {})
388
+ # @param [Hash] params ({})
389
+ def create_assistant(params = {}, options = {})
390
+ req = build_request(:create_assistant, params)
391
+ req.send_request(options)
392
+ end
393
+
394
+ # Creates an association between an Amazon Connect Wisdom assistant and
395
+ # another resource. Currently, the only supported association is with a
396
+ # knowledge base. An assistant can have only a single association.
397
+ #
398
+ # @option params [required, String] :assistant_id
399
+ # The identifier of the Wisdom assistant. Can be either the ID or the
400
+ # ARN. URLs cannot contain the ARN.
401
+ #
402
+ # @option params [required, Types::AssistantAssociationInputData] :association
403
+ # The identifier of the associated resource.
404
+ #
405
+ # @option params [required, String] :association_type
406
+ # The type of association.
407
+ #
408
+ # @option params [String] :client_token
409
+ # A unique, case-sensitive identifier that you provide to ensure the
410
+ # idempotency of the request.
411
+ #
412
+ # **A suitable default value is auto-generated.** You should normally
413
+ # not need to pass this option.**
414
+ #
415
+ # @option params [Hash<String,String>] :tags
416
+ # The tags used to organize, track, or control access for this resource.
417
+ #
418
+ # @return [Types::CreateAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
419
+ #
420
+ # * {Types::CreateAssistantAssociationResponse#assistant_association #assistant_association} => Types::AssistantAssociationData
421
+ #
422
+ # @example Request syntax with placeholder values
423
+ #
424
+ # resp = client.create_assistant_association({
425
+ # assistant_id: "UuidOrArn", # required
426
+ # association: { # required
427
+ # knowledge_base_id: "Uuid",
428
+ # },
429
+ # association_type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
430
+ # client_token: "ClientToken",
431
+ # tags: {
432
+ # "TagKey" => "TagValue",
433
+ # },
434
+ # })
435
+ #
436
+ # @example Response structure
437
+ #
438
+ # resp.assistant_association.assistant_arn #=> String
439
+ # resp.assistant_association.assistant_association_arn #=> String
440
+ # resp.assistant_association.assistant_association_id #=> String
441
+ # resp.assistant_association.assistant_id #=> String
442
+ # resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
443
+ # resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
444
+ # resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
445
+ # resp.assistant_association.tags #=> Hash
446
+ # resp.assistant_association.tags["TagKey"] #=> String
447
+ #
448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantAssociation AWS API Documentation
449
+ #
450
+ # @overload create_assistant_association(params = {})
451
+ # @param [Hash] params ({})
452
+ def create_assistant_association(params = {}, options = {})
453
+ req = build_request(:create_assistant_association, params)
454
+ req.send_request(options)
455
+ end
456
+
457
+ # Creates Wisdom content. Before to calling this API, use
458
+ # [StartContentUpload][1] to upload an asset.
459
+ #
460
+ #
461
+ #
462
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
463
+ #
464
+ # @option params [String] :client_token
465
+ # A unique, case-sensitive identifier that you provide to ensure the
466
+ # idempotency of the request.
467
+ #
468
+ # **A suitable default value is auto-generated.** You should normally
469
+ # not need to pass this option.**
470
+ #
471
+ # @option params [required, String] :knowledge_base_id
472
+ # The the identifier of the knowledge base. Can be either the ID or the
473
+ # ARN. URLs cannot contain the ARN.
474
+ #
475
+ # @option params [Hash<String,String>] :metadata
476
+ # A key/value map to store attributes without affecting tagging or
477
+ # recommendations. For example, when synchronizing data between an
478
+ # external system and Wisdom, you can store an external version
479
+ # identifier as metadata to utilize for determining drift.
480
+ #
481
+ # @option params [required, String] :name
482
+ # The name of the content. Each piece of content in a knowledge base
483
+ # must have a unique name. You can retrieve a piece of content using
484
+ # only its knowledge base and its name with the [SearchContent][1] API.
485
+ #
486
+ #
487
+ #
488
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html
489
+ #
490
+ # @option params [String] :override_link_out_uri
491
+ # The URI you want to use for the article. If the knowledge base has a
492
+ # templateUri, setting this argument overrides it for this piece of
493
+ # content.
494
+ #
495
+ # @option params [Hash<String,String>] :tags
496
+ # The tags used to organize, track, or control access for this resource.
497
+ #
498
+ # @option params [String] :title
499
+ # The title of the content. If not set, the title is equal to the name.
500
+ #
501
+ # @option params [required, String] :upload_id
502
+ # A pointer to the uploaded asset. This value is returned by
503
+ # [StartContentUpload][1].
504
+ #
505
+ #
506
+ #
507
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
508
+ #
509
+ # @return [Types::CreateContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
510
+ #
511
+ # * {Types::CreateContentResponse#content #content} => Types::ContentData
512
+ #
513
+ # @example Request syntax with placeholder values
514
+ #
515
+ # resp = client.create_content({
516
+ # client_token: "NonEmptyString",
517
+ # knowledge_base_id: "UuidOrArn", # required
518
+ # metadata: {
519
+ # "NonEmptyString" => "NonEmptyString",
520
+ # },
521
+ # name: "Name", # required
522
+ # override_link_out_uri: "Uri",
523
+ # tags: {
524
+ # "TagKey" => "TagValue",
525
+ # },
526
+ # title: "ContentTitle",
527
+ # upload_id: "NonEmptyString", # required
528
+ # })
529
+ #
530
+ # @example Response structure
531
+ #
532
+ # resp.content.content_arn #=> String
533
+ # resp.content.content_id #=> String
534
+ # resp.content.content_type #=> String
535
+ # resp.content.knowledge_base_arn #=> String
536
+ # resp.content.knowledge_base_id #=> String
537
+ # resp.content.link_out_uri #=> String
538
+ # resp.content.metadata #=> Hash
539
+ # resp.content.metadata["NonEmptyString"] #=> String
540
+ # resp.content.name #=> String
541
+ # resp.content.revision_id #=> String
542
+ # resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
543
+ # resp.content.tags #=> Hash
544
+ # resp.content.tags["TagKey"] #=> String
545
+ # resp.content.title #=> String
546
+ # resp.content.url #=> String
547
+ # resp.content.url_expiry #=> Time
548
+ #
549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateContent AWS API Documentation
550
+ #
551
+ # @overload create_content(params = {})
552
+ # @param [Hash] params ({})
553
+ def create_content(params = {}, options = {})
554
+ req = build_request(:create_content, params)
555
+ req.send_request(options)
556
+ end
557
+
558
+ # Creates a knowledge base.
559
+ #
560
+ # <note markdown="1"> When using this API, you cannot reuse [Amazon AppIntegrations][1]
561
+ # DataIntegrations with external knowledge bases such as Salesforce and
562
+ # ServiceNow. If you do, you'll get an `InvalidRequestException` error.
563
+ #
564
+ # <p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>
565
+ #
566
+ # </note>
567
+ #
568
+ #
569
+ #
570
+ # [1]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html
571
+ #
572
+ # @option params [String] :client_token
573
+ # A unique, case-sensitive identifier that you provide to ensure the
574
+ # idempotency of the request.
575
+ #
576
+ # **A suitable default value is auto-generated.** You should normally
577
+ # not need to pass this option.**
578
+ #
579
+ # @option params [String] :description
580
+ # The description.
581
+ #
582
+ # @option params [required, String] :knowledge_base_type
583
+ # The type of knowledge base. Only CUSTOM knowledge bases allow you to
584
+ # upload your own content. EXTERNAL knowledge bases support integrations
585
+ # with third-party systems whose content is synchronized automatically.
586
+ #
587
+ # @option params [required, String] :name
588
+ # The name of the knowledge base.
589
+ #
590
+ # @option params [Types::RenderingConfiguration] :rendering_configuration
591
+ # Information about how to render the content.
592
+ #
593
+ # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
594
+ # The KMS key used for encryption.
595
+ #
596
+ # @option params [Types::SourceConfiguration] :source_configuration
597
+ # The source of the knowledge base content. Only set this argument for
598
+ # EXTERNAL knowledge bases.
599
+ #
600
+ # @option params [Hash<String,String>] :tags
601
+ # The tags used to organize, track, or control access for this resource.
602
+ #
603
+ # @return [Types::CreateKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
604
+ #
605
+ # * {Types::CreateKnowledgeBaseResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
606
+ #
607
+ # @example Request syntax with placeholder values
608
+ #
609
+ # resp = client.create_knowledge_base({
610
+ # client_token: "NonEmptyString",
611
+ # description: "Description",
612
+ # knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM
613
+ # name: "Name", # required
614
+ # rendering_configuration: {
615
+ # template_uri: "Uri",
616
+ # },
617
+ # server_side_encryption_configuration: {
618
+ # kms_key_id: "NonEmptyString",
619
+ # },
620
+ # source_configuration: {
621
+ # app_integrations: {
622
+ # app_integration_arn: "GenericArn", # required
623
+ # object_fields: ["NonEmptyString"], # required
624
+ # },
625
+ # },
626
+ # tags: {
627
+ # "TagKey" => "TagValue",
628
+ # },
629
+ # })
630
+ #
631
+ # @example Response structure
632
+ #
633
+ # resp.knowledge_base.description #=> String
634
+ # resp.knowledge_base.knowledge_base_arn #=> String
635
+ # resp.knowledge_base.knowledge_base_id #=> String
636
+ # resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
637
+ # resp.knowledge_base.last_content_modification_time #=> Time
638
+ # resp.knowledge_base.name #=> String
639
+ # resp.knowledge_base.rendering_configuration.template_uri #=> String
640
+ # resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
641
+ # resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
642
+ # resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
643
+ # resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
644
+ # resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
645
+ # resp.knowledge_base.tags #=> Hash
646
+ # resp.knowledge_base.tags["TagKey"] #=> String
647
+ #
648
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateKnowledgeBase AWS API Documentation
649
+ #
650
+ # @overload create_knowledge_base(params = {})
651
+ # @param [Hash] params ({})
652
+ def create_knowledge_base(params = {}, options = {})
653
+ req = build_request(:create_knowledge_base, params)
654
+ req.send_request(options)
655
+ end
656
+
657
+ # Creates a session. A session is a contextual container used for
658
+ # generating recommendations. Amazon Connect creates a new Wisdom
659
+ # session for each contact on which Wisdom is enabled.
660
+ #
661
+ # @option params [required, String] :assistant_id
662
+ # The identifier of the Wisdom assistant. Can be either the ID or the
663
+ # ARN. URLs cannot contain the ARN.
664
+ #
665
+ # @option params [String] :client_token
666
+ # A unique, case-sensitive identifier that you provide to ensure the
667
+ # idempotency of the request.
668
+ #
669
+ # **A suitable default value is auto-generated.** You should normally
670
+ # not need to pass this option.**
671
+ #
672
+ # @option params [String] :description
673
+ # The description.
674
+ #
675
+ # @option params [required, String] :name
676
+ # The name of the session.
677
+ #
678
+ # @option params [Hash<String,String>] :tags
679
+ # The tags used to organize, track, or control access for this resource.
680
+ #
681
+ # @return [Types::CreateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
682
+ #
683
+ # * {Types::CreateSessionResponse#session #session} => Types::SessionData
684
+ #
685
+ # @example Request syntax with placeholder values
686
+ #
687
+ # resp = client.create_session({
688
+ # assistant_id: "UuidOrArn", # required
689
+ # client_token: "ClientToken",
690
+ # description: "Description",
691
+ # name: "Name", # required
692
+ # tags: {
693
+ # "TagKey" => "TagValue",
694
+ # },
695
+ # })
696
+ #
697
+ # @example Response structure
698
+ #
699
+ # resp.session.description #=> String
700
+ # resp.session.name #=> String
701
+ # resp.session.session_arn #=> String
702
+ # resp.session.session_id #=> String
703
+ # resp.session.tags #=> Hash
704
+ # resp.session.tags["TagKey"] #=> String
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateSession AWS API Documentation
707
+ #
708
+ # @overload create_session(params = {})
709
+ # @param [Hash] params ({})
710
+ def create_session(params = {}, options = {})
711
+ req = build_request(:create_session, params)
712
+ req.send_request(options)
713
+ end
714
+
715
+ # Deletes an assistant.
716
+ #
717
+ # @option params [required, String] :assistant_id
718
+ # The identifier of the Wisdom assistant. Can be either the ID or the
719
+ # ARN. URLs cannot contain the ARN.
720
+ #
721
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
722
+ #
723
+ # @example Request syntax with placeholder values
724
+ #
725
+ # resp = client.delete_assistant({
726
+ # assistant_id: "UuidOrArn", # required
727
+ # })
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistant AWS API Documentation
730
+ #
731
+ # @overload delete_assistant(params = {})
732
+ # @param [Hash] params ({})
733
+ def delete_assistant(params = {}, options = {})
734
+ req = build_request(:delete_assistant, params)
735
+ req.send_request(options)
736
+ end
737
+
738
+ # Deletes an assistant association.
739
+ #
740
+ # @option params [required, String] :assistant_association_id
741
+ # The identifier of the assistant association. Can be either the ID or
742
+ # the ARN. URLs cannot contain the ARN.
743
+ #
744
+ # @option params [required, String] :assistant_id
745
+ # The identifier of the Wisdom assistant. Can be either the ID or the
746
+ # ARN. URLs cannot contain the ARN.
747
+ #
748
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
749
+ #
750
+ # @example Request syntax with placeholder values
751
+ #
752
+ # resp = client.delete_assistant_association({
753
+ # assistant_association_id: "UuidOrArn", # required
754
+ # assistant_id: "UuidOrArn", # required
755
+ # })
756
+ #
757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantAssociation AWS API Documentation
758
+ #
759
+ # @overload delete_assistant_association(params = {})
760
+ # @param [Hash] params ({})
761
+ def delete_assistant_association(params = {}, options = {})
762
+ req = build_request(:delete_assistant_association, params)
763
+ req.send_request(options)
764
+ end
765
+
766
+ # Deletes the content.
767
+ #
768
+ # @option params [required, String] :content_id
769
+ # The identifier of the content. Can be either the ID or the ARN. URLs
770
+ # cannot contain the ARN.
771
+ #
772
+ # @option params [required, String] :knowledge_base_id
773
+ # The the identifier of the knowledge base. Can be either the ID or the
774
+ # ARN. URLs cannot contain the ARN.
775
+ #
776
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
777
+ #
778
+ # @example Request syntax with placeholder values
779
+ #
780
+ # resp = client.delete_content({
781
+ # content_id: "UuidOrArn", # required
782
+ # knowledge_base_id: "UuidOrArn", # required
783
+ # })
784
+ #
785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContent AWS API Documentation
786
+ #
787
+ # @overload delete_content(params = {})
788
+ # @param [Hash] params ({})
789
+ def delete_content(params = {}, options = {})
790
+ req = build_request(:delete_content, params)
791
+ req.send_request(options)
792
+ end
793
+
794
+ # Deletes the knowledge base.
795
+ #
796
+ # <note markdown="1"> When you use this API to delete an external knowledge base such as
797
+ # Salesforce or ServiceNow, you must also delete the [Amazon
798
+ # AppIntegrations][1] DataIntegration. This is because you can't reuse
799
+ # the DataIntegration after it's been associated with an external
800
+ # knowledge base. However, you can delete and recreate it. See
801
+ # [DeleteDataIntegration][2] and [CreateDataIntegration][3] in the
802
+ # *Amazon AppIntegrations API Reference*.
803
+ #
804
+ # </note>
805
+ #
806
+ #
807
+ #
808
+ # [1]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html
809
+ # [2]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html
810
+ # [3]: https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html
811
+ #
812
+ # @option params [required, String] :knowledge_base_id
813
+ # The knowledge base to delete content from. Can be either the ID or the
814
+ # ARN. URLs cannot contain the ARN.
815
+ #
816
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
817
+ #
818
+ # @example Request syntax with placeholder values
819
+ #
820
+ # resp = client.delete_knowledge_base({
821
+ # knowledge_base_id: "UuidOrArn", # required
822
+ # })
823
+ #
824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteKnowledgeBase AWS API Documentation
825
+ #
826
+ # @overload delete_knowledge_base(params = {})
827
+ # @param [Hash] params ({})
828
+ def delete_knowledge_base(params = {}, options = {})
829
+ req = build_request(:delete_knowledge_base, params)
830
+ req.send_request(options)
831
+ end
832
+
833
+ # Retrieves information about an assistant.
834
+ #
835
+ # @option params [required, String] :assistant_id
836
+ # The identifier of the Wisdom assistant. Can be either the ID or the
837
+ # ARN. URLs cannot contain the ARN.
838
+ #
839
+ # @return [Types::GetAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
840
+ #
841
+ # * {Types::GetAssistantResponse#assistant #assistant} => Types::AssistantData
842
+ #
843
+ # @example Request syntax with placeholder values
844
+ #
845
+ # resp = client.get_assistant({
846
+ # assistant_id: "UuidOrArn", # required
847
+ # })
848
+ #
849
+ # @example Response structure
850
+ #
851
+ # resp.assistant.assistant_arn #=> String
852
+ # resp.assistant.assistant_id #=> String
853
+ # resp.assistant.description #=> String
854
+ # resp.assistant.name #=> String
855
+ # resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
856
+ # resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
857
+ # resp.assistant.tags #=> Hash
858
+ # resp.assistant.tags["TagKey"] #=> String
859
+ # resp.assistant.type #=> String, one of "AGENT"
860
+ #
861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistant AWS API Documentation
862
+ #
863
+ # @overload get_assistant(params = {})
864
+ # @param [Hash] params ({})
865
+ def get_assistant(params = {}, options = {})
866
+ req = build_request(:get_assistant, params)
867
+ req.send_request(options)
868
+ end
869
+
870
+ # Retrieves information about an assistant association.
871
+ #
872
+ # @option params [required, String] :assistant_association_id
873
+ # The identifier of the assistant association. Can be either the ID or
874
+ # the ARN. URLs cannot contain the ARN.
875
+ #
876
+ # @option params [required, String] :assistant_id
877
+ # The identifier of the Wisdom assistant. Can be either the ID or the
878
+ # ARN. URLs cannot contain the ARN.
879
+ #
880
+ # @return [Types::GetAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
881
+ #
882
+ # * {Types::GetAssistantAssociationResponse#assistant_association #assistant_association} => Types::AssistantAssociationData
883
+ #
884
+ # @example Request syntax with placeholder values
885
+ #
886
+ # resp = client.get_assistant_association({
887
+ # assistant_association_id: "UuidOrArn", # required
888
+ # assistant_id: "UuidOrArn", # required
889
+ # })
890
+ #
891
+ # @example Response structure
892
+ #
893
+ # resp.assistant_association.assistant_arn #=> String
894
+ # resp.assistant_association.assistant_association_arn #=> String
895
+ # resp.assistant_association.assistant_association_id #=> String
896
+ # resp.assistant_association.assistant_id #=> String
897
+ # resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
898
+ # resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
899
+ # resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
900
+ # resp.assistant_association.tags #=> Hash
901
+ # resp.assistant_association.tags["TagKey"] #=> String
902
+ #
903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantAssociation AWS API Documentation
904
+ #
905
+ # @overload get_assistant_association(params = {})
906
+ # @param [Hash] params ({})
907
+ def get_assistant_association(params = {}, options = {})
908
+ req = build_request(:get_assistant_association, params)
909
+ req.send_request(options)
910
+ end
911
+
912
+ # Retrieves content, including a pre-signed URL to download the content.
913
+ #
914
+ # @option params [required, String] :content_id
915
+ # The identifier of the content. Can be either the ID or the ARN. URLs
916
+ # cannot contain the ARN.
917
+ #
918
+ # @option params [required, String] :knowledge_base_id
919
+ # The the identifier of the knowledge base. Can be either the ID or the
920
+ # ARN. URLs cannot contain the ARN.
921
+ #
922
+ # @return [Types::GetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
923
+ #
924
+ # * {Types::GetContentResponse#content #content} => Types::ContentData
925
+ #
926
+ # @example Request syntax with placeholder values
927
+ #
928
+ # resp = client.get_content({
929
+ # content_id: "UuidOrArn", # required
930
+ # knowledge_base_id: "UuidOrArn", # required
931
+ # })
932
+ #
933
+ # @example Response structure
934
+ #
935
+ # resp.content.content_arn #=> String
936
+ # resp.content.content_id #=> String
937
+ # resp.content.content_type #=> String
938
+ # resp.content.knowledge_base_arn #=> String
939
+ # resp.content.knowledge_base_id #=> String
940
+ # resp.content.link_out_uri #=> String
941
+ # resp.content.metadata #=> Hash
942
+ # resp.content.metadata["NonEmptyString"] #=> String
943
+ # resp.content.name #=> String
944
+ # resp.content.revision_id #=> String
945
+ # resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
946
+ # resp.content.tags #=> Hash
947
+ # resp.content.tags["TagKey"] #=> String
948
+ # resp.content.title #=> String
949
+ # resp.content.url #=> String
950
+ # resp.content.url_expiry #=> Time
951
+ #
952
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContent AWS API Documentation
953
+ #
954
+ # @overload get_content(params = {})
955
+ # @param [Hash] params ({})
956
+ def get_content(params = {}, options = {})
957
+ req = build_request(:get_content, params)
958
+ req.send_request(options)
959
+ end
960
+
961
+ # Retrieves summary information about the content.
962
+ #
963
+ # @option params [required, String] :content_id
964
+ # The identifier of the content. Can be either the ID or the ARN. URLs
965
+ # cannot contain the ARN.
966
+ #
967
+ # @option params [required, String] :knowledge_base_id
968
+ # The the identifier of the knowledge base. Can be either the ID or the
969
+ # ARN. URLs cannot contain the ARN.
970
+ #
971
+ # @return [Types::GetContentSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
972
+ #
973
+ # * {Types::GetContentSummaryResponse#content_summary #content_summary} => Types::ContentSummary
974
+ #
975
+ # @example Request syntax with placeholder values
976
+ #
977
+ # resp = client.get_content_summary({
978
+ # content_id: "UuidOrArn", # required
979
+ # knowledge_base_id: "UuidOrArn", # required
980
+ # })
981
+ #
982
+ # @example Response structure
983
+ #
984
+ # resp.content_summary.content_arn #=> String
985
+ # resp.content_summary.content_id #=> String
986
+ # resp.content_summary.content_type #=> String
987
+ # resp.content_summary.knowledge_base_arn #=> String
988
+ # resp.content_summary.knowledge_base_id #=> String
989
+ # resp.content_summary.metadata #=> Hash
990
+ # resp.content_summary.metadata["NonEmptyString"] #=> String
991
+ # resp.content_summary.name #=> String
992
+ # resp.content_summary.revision_id #=> String
993
+ # resp.content_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
994
+ # resp.content_summary.tags #=> Hash
995
+ # resp.content_summary.tags["TagKey"] #=> String
996
+ # resp.content_summary.title #=> String
997
+ #
998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummary AWS API Documentation
999
+ #
1000
+ # @overload get_content_summary(params = {})
1001
+ # @param [Hash] params ({})
1002
+ def get_content_summary(params = {}, options = {})
1003
+ req = build_request(:get_content_summary, params)
1004
+ req.send_request(options)
1005
+ end
1006
+
1007
+ # Retrieves information about the knowledge base.
1008
+ #
1009
+ # @option params [required, String] :knowledge_base_id
1010
+ # The the identifier of the knowledge base. Can be either the ID or the
1011
+ # ARN. URLs cannot contain the ARN.
1012
+ #
1013
+ # @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1014
+ #
1015
+ # * {Types::GetKnowledgeBaseResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
1016
+ #
1017
+ # @example Request syntax with placeholder values
1018
+ #
1019
+ # resp = client.get_knowledge_base({
1020
+ # knowledge_base_id: "UuidOrArn", # required
1021
+ # })
1022
+ #
1023
+ # @example Response structure
1024
+ #
1025
+ # resp.knowledge_base.description #=> String
1026
+ # resp.knowledge_base.knowledge_base_arn #=> String
1027
+ # resp.knowledge_base.knowledge_base_id #=> String
1028
+ # resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
1029
+ # resp.knowledge_base.last_content_modification_time #=> Time
1030
+ # resp.knowledge_base.name #=> String
1031
+ # resp.knowledge_base.rendering_configuration.template_uri #=> String
1032
+ # resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
1033
+ # resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
1034
+ # resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
1035
+ # resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
1036
+ # resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
1037
+ # resp.knowledge_base.tags #=> Hash
1038
+ # resp.knowledge_base.tags["TagKey"] #=> String
1039
+ #
1040
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBase AWS API Documentation
1041
+ #
1042
+ # @overload get_knowledge_base(params = {})
1043
+ # @param [Hash] params ({})
1044
+ def get_knowledge_base(params = {}, options = {})
1045
+ req = build_request(:get_knowledge_base, params)
1046
+ req.send_request(options)
1047
+ end
1048
+
1049
+ # Retrieves recommendations for the specified session. To avoid
1050
+ # retrieving the same recommendations in subsequent calls, use
1051
+ # [NotifyRecommendationsReceived][1]. This API supports long-polling
1052
+ # behavior with the `waitTimeSeconds` parameter. Short poll is the
1053
+ # default behavior and only returns recommendations already available.
1054
+ # To perform a manual query against an assistant, use
1055
+ # [QueryAssistant][2].
1056
+ #
1057
+ #
1058
+ #
1059
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html
1060
+ # [2]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html
1061
+ #
1062
+ # @option params [required, String] :assistant_id
1063
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1064
+ # ARN. URLs cannot contain the ARN.
1065
+ #
1066
+ # @option params [Integer] :max_results
1067
+ # The maximum number of results to return per page.
1068
+ #
1069
+ # @option params [required, String] :session_id
1070
+ # The identifier of the session. Can be either the ID or the ARN. URLs
1071
+ # cannot contain the ARN.
1072
+ #
1073
+ # @option params [Integer] :wait_time_seconds
1074
+ # The duration (in seconds) for which the call waits for a
1075
+ # recommendation to be made available before returning. If a
1076
+ # recommendation is available, the call returns sooner than
1077
+ # `WaitTimeSeconds`. If no messages are available and the wait time
1078
+ # expires, the call returns successfully with an empty list.
1079
+ #
1080
+ # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1081
+ #
1082
+ # * {Types::GetRecommendationsResponse#recommendations #recommendations} => Array&lt;Types::RecommendationData&gt;
1083
+ #
1084
+ # @example Request syntax with placeholder values
1085
+ #
1086
+ # resp = client.get_recommendations({
1087
+ # assistant_id: "UuidOrArn", # required
1088
+ # max_results: 1,
1089
+ # session_id: "UuidOrArn", # required
1090
+ # wait_time_seconds: 1,
1091
+ # })
1092
+ #
1093
+ # @example Response structure
1094
+ #
1095
+ # resp.recommendations #=> Array
1096
+ # resp.recommendations[0].document.content_reference.content_arn #=> String
1097
+ # resp.recommendations[0].document.content_reference.content_id #=> String
1098
+ # resp.recommendations[0].document.content_reference.knowledge_base_arn #=> String
1099
+ # resp.recommendations[0].document.content_reference.knowledge_base_id #=> String
1100
+ # resp.recommendations[0].document.excerpt.highlights #=> Array
1101
+ # resp.recommendations[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
1102
+ # resp.recommendations[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
1103
+ # resp.recommendations[0].document.excerpt.text #=> String
1104
+ # resp.recommendations[0].document.title.highlights #=> Array
1105
+ # resp.recommendations[0].document.title.highlights[0].begin_offset_inclusive #=> Integer
1106
+ # resp.recommendations[0].document.title.highlights[0].end_offset_exclusive #=> Integer
1107
+ # resp.recommendations[0].document.title.text #=> String
1108
+ # resp.recommendations[0].recommendation_id #=> String
1109
+ # resp.recommendations[0].relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
1110
+ # resp.recommendations[0].relevance_score #=> Float
1111
+ #
1112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetRecommendations AWS API Documentation
1113
+ #
1114
+ # @overload get_recommendations(params = {})
1115
+ # @param [Hash] params ({})
1116
+ def get_recommendations(params = {}, options = {})
1117
+ req = build_request(:get_recommendations, params)
1118
+ req.send_request(options)
1119
+ end
1120
+
1121
+ # Retrieves information for a specified session.
1122
+ #
1123
+ # @option params [required, String] :assistant_id
1124
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1125
+ # ARN. URLs cannot contain the ARN.
1126
+ #
1127
+ # @option params [required, String] :session_id
1128
+ # The identifier of the session. Can be either the ID or the ARN. URLs
1129
+ # cannot contain the ARN.
1130
+ #
1131
+ # @return [Types::GetSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1132
+ #
1133
+ # * {Types::GetSessionResponse#session #session} => Types::SessionData
1134
+ #
1135
+ # @example Request syntax with placeholder values
1136
+ #
1137
+ # resp = client.get_session({
1138
+ # assistant_id: "UuidOrArn", # required
1139
+ # session_id: "UuidOrArn", # required
1140
+ # })
1141
+ #
1142
+ # @example Response structure
1143
+ #
1144
+ # resp.session.description #=> String
1145
+ # resp.session.name #=> String
1146
+ # resp.session.session_arn #=> String
1147
+ # resp.session.session_id #=> String
1148
+ # resp.session.tags #=> Hash
1149
+ # resp.session.tags["TagKey"] #=> String
1150
+ #
1151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetSession AWS API Documentation
1152
+ #
1153
+ # @overload get_session(params = {})
1154
+ # @param [Hash] params ({})
1155
+ def get_session(params = {}, options = {})
1156
+ req = build_request(:get_session, params)
1157
+ req.send_request(options)
1158
+ end
1159
+
1160
+ # Lists information about assistant associations.
1161
+ #
1162
+ # @option params [required, String] :assistant_id
1163
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1164
+ # ARN. URLs cannot contain the ARN.
1165
+ #
1166
+ # @option params [Integer] :max_results
1167
+ # The maximum number of results to return per page.
1168
+ #
1169
+ # @option params [String] :next_token
1170
+ # The token for the next set of results. Use the value returned in the
1171
+ # previous response in the next request to retrieve the next set of
1172
+ # results.
1173
+ #
1174
+ # @return [Types::ListAssistantAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1175
+ #
1176
+ # * {Types::ListAssistantAssociationsResponse#assistant_association_summaries #assistant_association_summaries} => Array&lt;Types::AssistantAssociationSummary&gt;
1177
+ # * {Types::ListAssistantAssociationsResponse#next_token #next_token} => String
1178
+ #
1179
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1180
+ #
1181
+ # @example Request syntax with placeholder values
1182
+ #
1183
+ # resp = client.list_assistant_associations({
1184
+ # assistant_id: "UuidOrArn", # required
1185
+ # max_results: 1,
1186
+ # next_token: "NextToken",
1187
+ # })
1188
+ #
1189
+ # @example Response structure
1190
+ #
1191
+ # resp.assistant_association_summaries #=> Array
1192
+ # resp.assistant_association_summaries[0].assistant_arn #=> String
1193
+ # resp.assistant_association_summaries[0].assistant_association_arn #=> String
1194
+ # resp.assistant_association_summaries[0].assistant_association_id #=> String
1195
+ # resp.assistant_association_summaries[0].assistant_id #=> String
1196
+ # resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_arn #=> String
1197
+ # resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_id #=> String
1198
+ # resp.assistant_association_summaries[0].association_type #=> String, one of "KNOWLEDGE_BASE"
1199
+ # resp.assistant_association_summaries[0].tags #=> Hash
1200
+ # resp.assistant_association_summaries[0].tags["TagKey"] #=> String
1201
+ # resp.next_token #=> String
1202
+ #
1203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantAssociations AWS API Documentation
1204
+ #
1205
+ # @overload list_assistant_associations(params = {})
1206
+ # @param [Hash] params ({})
1207
+ def list_assistant_associations(params = {}, options = {})
1208
+ req = build_request(:list_assistant_associations, params)
1209
+ req.send_request(options)
1210
+ end
1211
+
1212
+ # Lists information about assistants.
1213
+ #
1214
+ # @option params [Integer] :max_results
1215
+ # The maximum number of results to return per page.
1216
+ #
1217
+ # @option params [String] :next_token
1218
+ # The token for the next set of results. Use the value returned in the
1219
+ # previous response in the next request to retrieve the next set of
1220
+ # results.
1221
+ #
1222
+ # @return [Types::ListAssistantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1223
+ #
1224
+ # * {Types::ListAssistantsResponse#assistant_summaries #assistant_summaries} => Array&lt;Types::AssistantSummary&gt;
1225
+ # * {Types::ListAssistantsResponse#next_token #next_token} => String
1226
+ #
1227
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1228
+ #
1229
+ # @example Request syntax with placeholder values
1230
+ #
1231
+ # resp = client.list_assistants({
1232
+ # max_results: 1,
1233
+ # next_token: "NextToken",
1234
+ # })
1235
+ #
1236
+ # @example Response structure
1237
+ #
1238
+ # resp.assistant_summaries #=> Array
1239
+ # resp.assistant_summaries[0].assistant_arn #=> String
1240
+ # resp.assistant_summaries[0].assistant_id #=> String
1241
+ # resp.assistant_summaries[0].description #=> String
1242
+ # resp.assistant_summaries[0].name #=> String
1243
+ # resp.assistant_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
1244
+ # resp.assistant_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
1245
+ # resp.assistant_summaries[0].tags #=> Hash
1246
+ # resp.assistant_summaries[0].tags["TagKey"] #=> String
1247
+ # resp.assistant_summaries[0].type #=> String, one of "AGENT"
1248
+ # resp.next_token #=> String
1249
+ #
1250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistants AWS API Documentation
1251
+ #
1252
+ # @overload list_assistants(params = {})
1253
+ # @param [Hash] params ({})
1254
+ def list_assistants(params = {}, options = {})
1255
+ req = build_request(:list_assistants, params)
1256
+ req.send_request(options)
1257
+ end
1258
+
1259
+ # Lists the content.
1260
+ #
1261
+ # @option params [required, String] :knowledge_base_id
1262
+ # The the identifier of the knowledge base. Can be either the ID or the
1263
+ # ARN. URLs cannot contain the ARN.
1264
+ #
1265
+ # @option params [Integer] :max_results
1266
+ # The maximum number of results to return per page.
1267
+ #
1268
+ # @option params [String] :next_token
1269
+ # The token for the next set of results. Use the value returned in the
1270
+ # previous response in the next request to retrieve the next set of
1271
+ # results.
1272
+ #
1273
+ # @return [Types::ListContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1274
+ #
1275
+ # * {Types::ListContentsResponse#content_summaries #content_summaries} => Array&lt;Types::ContentSummary&gt;
1276
+ # * {Types::ListContentsResponse#next_token #next_token} => String
1277
+ #
1278
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1279
+ #
1280
+ # @example Request syntax with placeholder values
1281
+ #
1282
+ # resp = client.list_contents({
1283
+ # knowledge_base_id: "UuidOrArn", # required
1284
+ # max_results: 1,
1285
+ # next_token: "NextToken",
1286
+ # })
1287
+ #
1288
+ # @example Response structure
1289
+ #
1290
+ # resp.content_summaries #=> Array
1291
+ # resp.content_summaries[0].content_arn #=> String
1292
+ # resp.content_summaries[0].content_id #=> String
1293
+ # resp.content_summaries[0].content_type #=> String
1294
+ # resp.content_summaries[0].knowledge_base_arn #=> String
1295
+ # resp.content_summaries[0].knowledge_base_id #=> String
1296
+ # resp.content_summaries[0].metadata #=> Hash
1297
+ # resp.content_summaries[0].metadata["NonEmptyString"] #=> String
1298
+ # resp.content_summaries[0].name #=> String
1299
+ # resp.content_summaries[0].revision_id #=> String
1300
+ # resp.content_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
1301
+ # resp.content_summaries[0].tags #=> Hash
1302
+ # resp.content_summaries[0].tags["TagKey"] #=> String
1303
+ # resp.content_summaries[0].title #=> String
1304
+ # resp.next_token #=> String
1305
+ #
1306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListContents AWS API Documentation
1307
+ #
1308
+ # @overload list_contents(params = {})
1309
+ # @param [Hash] params ({})
1310
+ def list_contents(params = {}, options = {})
1311
+ req = build_request(:list_contents, params)
1312
+ req.send_request(options)
1313
+ end
1314
+
1315
+ # Lists the knowledge bases.
1316
+ #
1317
+ # @option params [Integer] :max_results
1318
+ # The maximum number of results to return per page.
1319
+ #
1320
+ # @option params [String] :next_token
1321
+ # The token for the next set of results. Use the value returned in the
1322
+ # previous response in the next request to retrieve the next set of
1323
+ # results.
1324
+ #
1325
+ # @return [Types::ListKnowledgeBasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1326
+ #
1327
+ # * {Types::ListKnowledgeBasesResponse#knowledge_base_summaries #knowledge_base_summaries} => Array&lt;Types::KnowledgeBaseSummary&gt;
1328
+ # * {Types::ListKnowledgeBasesResponse#next_token #next_token} => String
1329
+ #
1330
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1331
+ #
1332
+ # @example Request syntax with placeholder values
1333
+ #
1334
+ # resp = client.list_knowledge_bases({
1335
+ # max_results: 1,
1336
+ # next_token: "NonEmptyString",
1337
+ # })
1338
+ #
1339
+ # @example Response structure
1340
+ #
1341
+ # resp.knowledge_base_summaries #=> Array
1342
+ # resp.knowledge_base_summaries[0].description #=> String
1343
+ # resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
1344
+ # resp.knowledge_base_summaries[0].knowledge_base_id #=> String
1345
+ # resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
1346
+ # resp.knowledge_base_summaries[0].name #=> String
1347
+ # resp.knowledge_base_summaries[0].rendering_configuration.template_uri #=> String
1348
+ # resp.knowledge_base_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
1349
+ # resp.knowledge_base_summaries[0].source_configuration.app_integrations.app_integration_arn #=> String
1350
+ # resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields #=> Array
1351
+ # resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields[0] #=> String
1352
+ # resp.knowledge_base_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
1353
+ # resp.knowledge_base_summaries[0].tags #=> Hash
1354
+ # resp.knowledge_base_summaries[0].tags["TagKey"] #=> String
1355
+ # resp.next_token #=> String
1356
+ #
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListKnowledgeBases AWS API Documentation
1358
+ #
1359
+ # @overload list_knowledge_bases(params = {})
1360
+ # @param [Hash] params ({})
1361
+ def list_knowledge_bases(params = {}, options = {})
1362
+ req = build_request(:list_knowledge_bases, params)
1363
+ req.send_request(options)
1364
+ end
1365
+
1366
+ # Lists the tags for the specified resource.
1367
+ #
1368
+ # @option params [required, String] :resource_arn
1369
+ # The Amazon Resource Name (ARN) of the resource.
1370
+ #
1371
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1372
+ #
1373
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1374
+ #
1375
+ # @example Request syntax with placeholder values
1376
+ #
1377
+ # resp = client.list_tags_for_resource({
1378
+ # resource_arn: "Arn", # required
1379
+ # })
1380
+ #
1381
+ # @example Response structure
1382
+ #
1383
+ # resp.tags #=> Hash
1384
+ # resp.tags["TagKey"] #=> String
1385
+ #
1386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListTagsForResource AWS API Documentation
1387
+ #
1388
+ # @overload list_tags_for_resource(params = {})
1389
+ # @param [Hash] params ({})
1390
+ def list_tags_for_resource(params = {}, options = {})
1391
+ req = build_request(:list_tags_for_resource, params)
1392
+ req.send_request(options)
1393
+ end
1394
+
1395
+ # Removes the specified recommendations from the specified assistant's
1396
+ # queue of newly available recommendations. You can use this API in
1397
+ # conjunction with [GetRecommendations][1] and a `waitTimeSeconds` input
1398
+ # for long-polling behavior and avoiding duplicate recommendations.
1399
+ #
1400
+ #
1401
+ #
1402
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html
1403
+ #
1404
+ # @option params [required, String] :assistant_id
1405
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1406
+ # ARN. URLs cannot contain the ARN.
1407
+ #
1408
+ # @option params [required, Array<String>] :recommendation_ids
1409
+ # The identifiers of the recommendations.
1410
+ #
1411
+ # @option params [required, String] :session_id
1412
+ # The identifier of the session. Can be either the ID or the ARN. URLs
1413
+ # cannot contain the ARN.
1414
+ #
1415
+ # @return [Types::NotifyRecommendationsReceivedResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1416
+ #
1417
+ # * {Types::NotifyRecommendationsReceivedResponse#errors #errors} => Array&lt;Types::NotifyRecommendationsReceivedError&gt;
1418
+ # * {Types::NotifyRecommendationsReceivedResponse#recommendation_ids #recommendation_ids} => Array&lt;String&gt;
1419
+ #
1420
+ # @example Request syntax with placeholder values
1421
+ #
1422
+ # resp = client.notify_recommendations_received({
1423
+ # assistant_id: "UuidOrArn", # required
1424
+ # recommendation_ids: ["String"], # required
1425
+ # session_id: "UuidOrArn", # required
1426
+ # })
1427
+ #
1428
+ # @example Response structure
1429
+ #
1430
+ # resp.errors #=> Array
1431
+ # resp.errors[0].message #=> String
1432
+ # resp.errors[0].recommendation_id #=> String
1433
+ # resp.recommendation_ids #=> Array
1434
+ # resp.recommendation_ids[0] #=> String
1435
+ #
1436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceived AWS API Documentation
1437
+ #
1438
+ # @overload notify_recommendations_received(params = {})
1439
+ # @param [Hash] params ({})
1440
+ def notify_recommendations_received(params = {}, options = {})
1441
+ req = build_request(:notify_recommendations_received, params)
1442
+ req.send_request(options)
1443
+ end
1444
+
1445
+ # Performs a manual search against the specified assistant. To retrieve
1446
+ # recommendations for an assistant, use [GetRecommendations][1].
1447
+ #
1448
+ #
1449
+ #
1450
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html
1451
+ #
1452
+ # @option params [required, String] :assistant_id
1453
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1454
+ # ARN. URLs cannot contain the ARN.
1455
+ #
1456
+ # @option params [Integer] :max_results
1457
+ # The maximum number of results to return per page.
1458
+ #
1459
+ # @option params [String] :next_token
1460
+ # The token for the next set of results. Use the value returned in the
1461
+ # previous response in the next request to retrieve the next set of
1462
+ # results.
1463
+ #
1464
+ # @option params [required, String] :query_text
1465
+ # The text to search for.
1466
+ #
1467
+ # @return [Types::QueryAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1468
+ #
1469
+ # * {Types::QueryAssistantResponse#next_token #next_token} => String
1470
+ # * {Types::QueryAssistantResponse#results #results} => Array&lt;Types::ResultData&gt;
1471
+ #
1472
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1473
+ #
1474
+ # @example Request syntax with placeholder values
1475
+ #
1476
+ # resp = client.query_assistant({
1477
+ # assistant_id: "UuidOrArn", # required
1478
+ # max_results: 1,
1479
+ # next_token: "NextToken",
1480
+ # query_text: "QueryText", # required
1481
+ # })
1482
+ #
1483
+ # @example Response structure
1484
+ #
1485
+ # resp.next_token #=> String
1486
+ # resp.results #=> Array
1487
+ # resp.results[0].document.content_reference.content_arn #=> String
1488
+ # resp.results[0].document.content_reference.content_id #=> String
1489
+ # resp.results[0].document.content_reference.knowledge_base_arn #=> String
1490
+ # resp.results[0].document.content_reference.knowledge_base_id #=> String
1491
+ # resp.results[0].document.excerpt.highlights #=> Array
1492
+ # resp.results[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
1493
+ # resp.results[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
1494
+ # resp.results[0].document.excerpt.text #=> String
1495
+ # resp.results[0].document.title.highlights #=> Array
1496
+ # resp.results[0].document.title.highlights[0].begin_offset_inclusive #=> Integer
1497
+ # resp.results[0].document.title.highlights[0].end_offset_exclusive #=> Integer
1498
+ # resp.results[0].document.title.text #=> String
1499
+ # resp.results[0].relevance_score #=> Float
1500
+ # resp.results[0].result_id #=> String
1501
+ #
1502
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistant AWS API Documentation
1503
+ #
1504
+ # @overload query_assistant(params = {})
1505
+ # @param [Hash] params ({})
1506
+ def query_assistant(params = {}, options = {})
1507
+ req = build_request(:query_assistant, params)
1508
+ req.send_request(options)
1509
+ end
1510
+
1511
+ # Removes a URI template from a knowledge base.
1512
+ #
1513
+ # @option params [required, String] :knowledge_base_id
1514
+ # The the identifier of the knowledge base. Can be either the ID or the
1515
+ # ARN. URLs cannot contain the ARN.
1516
+ #
1517
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1518
+ #
1519
+ # @example Request syntax with placeholder values
1520
+ #
1521
+ # resp = client.remove_knowledge_base_template_uri({
1522
+ # knowledge_base_id: "UuidOrArn", # required
1523
+ # })
1524
+ #
1525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUri AWS API Documentation
1526
+ #
1527
+ # @overload remove_knowledge_base_template_uri(params = {})
1528
+ # @param [Hash] params ({})
1529
+ def remove_knowledge_base_template_uri(params = {}, options = {})
1530
+ req = build_request(:remove_knowledge_base_template_uri, params)
1531
+ req.send_request(options)
1532
+ end
1533
+
1534
+ # Searches for content in a specified knowledge base. Can be used to get
1535
+ # a specific content resource by its name.
1536
+ #
1537
+ # @option params [required, String] :knowledge_base_id
1538
+ # The the identifier of the knowledge base. Can be either the ID or the
1539
+ # ARN. URLs cannot contain the ARN.
1540
+ #
1541
+ # @option params [Integer] :max_results
1542
+ # The maximum number of results to return per page.
1543
+ #
1544
+ # @option params [String] :next_token
1545
+ # The token for the next set of results. Use the value returned in the
1546
+ # previous response in the next request to retrieve the next set of
1547
+ # results.
1548
+ #
1549
+ # @option params [required, Types::SearchExpression] :search_expression
1550
+ # The search expression to filter results.
1551
+ #
1552
+ # @return [Types::SearchContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1553
+ #
1554
+ # * {Types::SearchContentResponse#content_summaries #content_summaries} => Array&lt;Types::ContentSummary&gt;
1555
+ # * {Types::SearchContentResponse#next_token #next_token} => String
1556
+ #
1557
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1558
+ #
1559
+ # @example Request syntax with placeholder values
1560
+ #
1561
+ # resp = client.search_content({
1562
+ # knowledge_base_id: "UuidOrArn", # required
1563
+ # max_results: 1,
1564
+ # next_token: "NextToken",
1565
+ # search_expression: { # required
1566
+ # filters: [ # required
1567
+ # {
1568
+ # field: "NAME", # required, accepts NAME
1569
+ # operator: "EQUALS", # required, accepts EQUALS
1570
+ # value: "NonEmptyString", # required
1571
+ # },
1572
+ # ],
1573
+ # },
1574
+ # })
1575
+ #
1576
+ # @example Response structure
1577
+ #
1578
+ # resp.content_summaries #=> Array
1579
+ # resp.content_summaries[0].content_arn #=> String
1580
+ # resp.content_summaries[0].content_id #=> String
1581
+ # resp.content_summaries[0].content_type #=> String
1582
+ # resp.content_summaries[0].knowledge_base_arn #=> String
1583
+ # resp.content_summaries[0].knowledge_base_id #=> String
1584
+ # resp.content_summaries[0].metadata #=> Hash
1585
+ # resp.content_summaries[0].metadata["NonEmptyString"] #=> String
1586
+ # resp.content_summaries[0].name #=> String
1587
+ # resp.content_summaries[0].revision_id #=> String
1588
+ # resp.content_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
1589
+ # resp.content_summaries[0].tags #=> Hash
1590
+ # resp.content_summaries[0].tags["TagKey"] #=> String
1591
+ # resp.content_summaries[0].title #=> String
1592
+ # resp.next_token #=> String
1593
+ #
1594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchContent AWS API Documentation
1595
+ #
1596
+ # @overload search_content(params = {})
1597
+ # @param [Hash] params ({})
1598
+ def search_content(params = {}, options = {})
1599
+ req = build_request(:search_content, params)
1600
+ req.send_request(options)
1601
+ end
1602
+
1603
+ # Searches for sessions.
1604
+ #
1605
+ # @option params [required, String] :assistant_id
1606
+ # The identifier of the Wisdom assistant. Can be either the ID or the
1607
+ # ARN. URLs cannot contain the ARN.
1608
+ #
1609
+ # @option params [Integer] :max_results
1610
+ # The maximum number of results to return per page.
1611
+ #
1612
+ # @option params [String] :next_token
1613
+ # The token for the next set of results. Use the value returned in the
1614
+ # previous response in the next request to retrieve the next set of
1615
+ # results.
1616
+ #
1617
+ # @option params [required, Types::SearchExpression] :search_expression
1618
+ # The search expression to filter results.
1619
+ #
1620
+ # @return [Types::SearchSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1621
+ #
1622
+ # * {Types::SearchSessionsResponse#next_token #next_token} => String
1623
+ # * {Types::SearchSessionsResponse#session_summaries #session_summaries} => Array&lt;Types::SessionSummary&gt;
1624
+ #
1625
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1626
+ #
1627
+ # @example Request syntax with placeholder values
1628
+ #
1629
+ # resp = client.search_sessions({
1630
+ # assistant_id: "UuidOrArn", # required
1631
+ # max_results: 1,
1632
+ # next_token: "NextToken",
1633
+ # search_expression: { # required
1634
+ # filters: [ # required
1635
+ # {
1636
+ # field: "NAME", # required, accepts NAME
1637
+ # operator: "EQUALS", # required, accepts EQUALS
1638
+ # value: "NonEmptyString", # required
1639
+ # },
1640
+ # ],
1641
+ # },
1642
+ # })
1643
+ #
1644
+ # @example Response structure
1645
+ #
1646
+ # resp.next_token #=> String
1647
+ # resp.session_summaries #=> Array
1648
+ # resp.session_summaries[0].assistant_arn #=> String
1649
+ # resp.session_summaries[0].assistant_id #=> String
1650
+ # resp.session_summaries[0].session_arn #=> String
1651
+ # resp.session_summaries[0].session_id #=> String
1652
+ #
1653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessions AWS API Documentation
1654
+ #
1655
+ # @overload search_sessions(params = {})
1656
+ # @param [Hash] params ({})
1657
+ def search_sessions(params = {}, options = {})
1658
+ req = build_request(:search_sessions, params)
1659
+ req.send_request(options)
1660
+ end
1661
+
1662
+ # Get a URL to upload content to a knowledge base. To upload content,
1663
+ # first make a PUT request to the returned URL with your file, making
1664
+ # sure to include the required headers. Then use [CreateContent][1] to
1665
+ # finalize the content creation process or [UpdateContent][2] to modify
1666
+ # an existing resource. You can only upload content to a knowledge base
1667
+ # of type CUSTOM.
1668
+ #
1669
+ #
1670
+ #
1671
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html
1672
+ # [2]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html
1673
+ #
1674
+ # @option params [required, String] :content_type
1675
+ # The type of content to upload.
1676
+ #
1677
+ # @option params [required, String] :knowledge_base_id
1678
+ # The the identifier of the knowledge base. Can be either the ID or the
1679
+ # ARN. URLs cannot contain the ARN.
1680
+ #
1681
+ # @return [Types::StartContentUploadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1682
+ #
1683
+ # * {Types::StartContentUploadResponse#headers_to_include #headers_to_include} => Hash&lt;String,String&gt;
1684
+ # * {Types::StartContentUploadResponse#upload_id #upload_id} => String
1685
+ # * {Types::StartContentUploadResponse#url #url} => String
1686
+ # * {Types::StartContentUploadResponse#url_expiry #url_expiry} => Time
1687
+ #
1688
+ # @example Request syntax with placeholder values
1689
+ #
1690
+ # resp = client.start_content_upload({
1691
+ # content_type: "ContentType", # required
1692
+ # knowledge_base_id: "UuidOrArn", # required
1693
+ # })
1694
+ #
1695
+ # @example Response structure
1696
+ #
1697
+ # resp.headers_to_include #=> Hash
1698
+ # resp.headers_to_include["NonEmptyString"] #=> String
1699
+ # resp.upload_id #=> String
1700
+ # resp.url #=> String
1701
+ # resp.url_expiry #=> Time
1702
+ #
1703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUpload AWS API Documentation
1704
+ #
1705
+ # @overload start_content_upload(params = {})
1706
+ # @param [Hash] params ({})
1707
+ def start_content_upload(params = {}, options = {})
1708
+ req = build_request(:start_content_upload, params)
1709
+ req.send_request(options)
1710
+ end
1711
+
1712
+ # Adds the specified tags to the specified resource.
1713
+ #
1714
+ # @option params [required, String] :resource_arn
1715
+ # The Amazon Resource Name (ARN) of the resource.
1716
+ #
1717
+ # @option params [required, Hash<String,String>] :tags
1718
+ # The tags used to organize, track, or control access for this resource.
1719
+ #
1720
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1721
+ #
1722
+ # @example Request syntax with placeholder values
1723
+ #
1724
+ # resp = client.tag_resource({
1725
+ # resource_arn: "Arn", # required
1726
+ # tags: { # required
1727
+ # "TagKey" => "TagValue",
1728
+ # },
1729
+ # })
1730
+ #
1731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TagResource AWS API Documentation
1732
+ #
1733
+ # @overload tag_resource(params = {})
1734
+ # @param [Hash] params ({})
1735
+ def tag_resource(params = {}, options = {})
1736
+ req = build_request(:tag_resource, params)
1737
+ req.send_request(options)
1738
+ end
1739
+
1740
+ # Removes the specified tags from the specified resource.
1741
+ #
1742
+ # @option params [required, String] :resource_arn
1743
+ # The Amazon Resource Name (ARN) of the resource.
1744
+ #
1745
+ # @option params [required, Array<String>] :tag_keys
1746
+ # The tag keys.
1747
+ #
1748
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1749
+ #
1750
+ # @example Request syntax with placeholder values
1751
+ #
1752
+ # resp = client.untag_resource({
1753
+ # resource_arn: "Arn", # required
1754
+ # tag_keys: ["TagKey"], # required
1755
+ # })
1756
+ #
1757
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UntagResource AWS API Documentation
1758
+ #
1759
+ # @overload untag_resource(params = {})
1760
+ # @param [Hash] params ({})
1761
+ def untag_resource(params = {}, options = {})
1762
+ req = build_request(:untag_resource, params)
1763
+ req.send_request(options)
1764
+ end
1765
+
1766
+ # Updates information about the content.
1767
+ #
1768
+ # @option params [required, String] :content_id
1769
+ # The identifier of the content. Can be either the ID or the ARN. URLs
1770
+ # cannot contain the ARN.
1771
+ #
1772
+ # @option params [required, String] :knowledge_base_id
1773
+ # The the identifier of the knowledge base. Can be either the ID or the
1774
+ # ARN
1775
+ #
1776
+ # @option params [Hash<String,String>] :metadata
1777
+ # A key/value map to store attributes without affecting tagging or
1778
+ # recommendations. For example, when synchronizing data between an
1779
+ # external system and Wisdom, you can store an external version
1780
+ # identifier as metadata to utilize for determining drift.
1781
+ #
1782
+ # @option params [String] :override_link_out_uri
1783
+ # The URI for the article. If the knowledge base has a templateUri,
1784
+ # setting this argument overrides it for this piece of content. To
1785
+ # remove an existing `overrideLinkOurUri`, exclude this argument and set
1786
+ # `removeOverrideLinkOutUri` to true.
1787
+ #
1788
+ # @option params [Boolean] :remove_override_link_out_uri
1789
+ # Unset the existing `overrideLinkOutUri` if it exists.
1790
+ #
1791
+ # @option params [String] :revision_id
1792
+ # The `revisionId` of the content resource to update, taken from an
1793
+ # earlier call to `GetContent`, `GetContentSummary`, `SearchContent`, or
1794
+ # `ListContents`. If included, this argument acts as an optimistic lock
1795
+ # to ensure content was not modified since it was last read. If it has
1796
+ # been modified, this API throws a `PreconditionFailedException`.
1797
+ #
1798
+ # @option params [String] :title
1799
+ # The title of the content.
1800
+ #
1801
+ # @option params [String] :upload_id
1802
+ # A pointer to the uploaded asset. This value is returned by
1803
+ # [StartContentUpload][1].
1804
+ #
1805
+ #
1806
+ #
1807
+ # [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
1808
+ #
1809
+ # @return [Types::UpdateContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1810
+ #
1811
+ # * {Types::UpdateContentResponse#content #content} => Types::ContentData
1812
+ #
1813
+ # @example Request syntax with placeholder values
1814
+ #
1815
+ # resp = client.update_content({
1816
+ # content_id: "UuidOrArn", # required
1817
+ # knowledge_base_id: "UuidOrArn", # required
1818
+ # metadata: {
1819
+ # "NonEmptyString" => "NonEmptyString",
1820
+ # },
1821
+ # override_link_out_uri: "Uri",
1822
+ # remove_override_link_out_uri: false,
1823
+ # revision_id: "NonEmptyString",
1824
+ # title: "ContentTitle",
1825
+ # upload_id: "NonEmptyString",
1826
+ # })
1827
+ #
1828
+ # @example Response structure
1829
+ #
1830
+ # resp.content.content_arn #=> String
1831
+ # resp.content.content_id #=> String
1832
+ # resp.content.content_type #=> String
1833
+ # resp.content.knowledge_base_arn #=> String
1834
+ # resp.content.knowledge_base_id #=> String
1835
+ # resp.content.link_out_uri #=> String
1836
+ # resp.content.metadata #=> Hash
1837
+ # resp.content.metadata["NonEmptyString"] #=> String
1838
+ # resp.content.name #=> String
1839
+ # resp.content.revision_id #=> String
1840
+ # resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
1841
+ # resp.content.tags #=> Hash
1842
+ # resp.content.tags["TagKey"] #=> String
1843
+ # resp.content.title #=> String
1844
+ # resp.content.url #=> String
1845
+ # resp.content.url_expiry #=> Time
1846
+ #
1847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateContent AWS API Documentation
1848
+ #
1849
+ # @overload update_content(params = {})
1850
+ # @param [Hash] params ({})
1851
+ def update_content(params = {}, options = {})
1852
+ req = build_request(:update_content, params)
1853
+ req.send_request(options)
1854
+ end
1855
+
1856
+ # Updates the template URI of a knowledge base. This is only supported
1857
+ # for knowledge bases of type EXTERNAL. Include a single variable in
1858
+ # `$\{variable\}` format; this interpolated by Wisdom using ingested
1859
+ # content. For example, if you ingest a Salesforce article, it has an
1860
+ # `Id` value, and you can set the template URI to
1861
+ # `https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*$\{Id\}*/view`.
1862
+ #
1863
+ # @option params [required, String] :knowledge_base_id
1864
+ # The the identifier of the knowledge base. Can be either the ID or the
1865
+ # ARN. URLs cannot contain the ARN.
1866
+ #
1867
+ # @option params [required, String] :template_uri
1868
+ # The template URI to update.
1869
+ #
1870
+ # @return [Types::UpdateKnowledgeBaseTemplateUriResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1871
+ #
1872
+ # * {Types::UpdateKnowledgeBaseTemplateUriResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
1873
+ #
1874
+ # @example Request syntax with placeholder values
1875
+ #
1876
+ # resp = client.update_knowledge_base_template_uri({
1877
+ # knowledge_base_id: "UuidOrArn", # required
1878
+ # template_uri: "Uri", # required
1879
+ # })
1880
+ #
1881
+ # @example Response structure
1882
+ #
1883
+ # resp.knowledge_base.description #=> String
1884
+ # resp.knowledge_base.knowledge_base_arn #=> String
1885
+ # resp.knowledge_base.knowledge_base_id #=> String
1886
+ # resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
1887
+ # resp.knowledge_base.last_content_modification_time #=> Time
1888
+ # resp.knowledge_base.name #=> String
1889
+ # resp.knowledge_base.rendering_configuration.template_uri #=> String
1890
+ # resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
1891
+ # resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
1892
+ # resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
1893
+ # resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
1894
+ # resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
1895
+ # resp.knowledge_base.tags #=> Hash
1896
+ # resp.knowledge_base.tags["TagKey"] #=> String
1897
+ #
1898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateKnowledgeBaseTemplateUri AWS API Documentation
1899
+ #
1900
+ # @overload update_knowledge_base_template_uri(params = {})
1901
+ # @param [Hash] params ({})
1902
+ def update_knowledge_base_template_uri(params = {}, options = {})
1903
+ req = build_request(:update_knowledge_base_template_uri, params)
1904
+ req.send_request(options)
1905
+ end
1906
+
1907
+ # @!endgroup
1908
+
1909
+ # @param params ({})
1910
+ # @api private
1911
+ def build_request(operation_name, params = {})
1912
+ handlers = @handlers.for(operation_name)
1913
+ context = Seahorse::Client::RequestContext.new(
1914
+ operation_name: operation_name,
1915
+ operation: config.api.operation(operation_name),
1916
+ client: self,
1917
+ params: params,
1918
+ config: config)
1919
+ context[:gem_name] = 'aws-sdk-connectwisdomservice'
1920
+ context[:gem_version] = '1.0.0'
1921
+ Seahorse::Client::Request.new(handlers, context)
1922
+ end
1923
+
1924
+ # @api private
1925
+ # @deprecated
1926
+ def waiter_names
1927
+ []
1928
+ end
1929
+
1930
+ class << self
1931
+
1932
+ # @api private
1933
+ attr_reader :identifier
1934
+
1935
+ # @api private
1936
+ def errors_module
1937
+ Errors
1938
+ end
1939
+
1940
+ end
1941
+ end
1942
+ end