aws-sdk-kendra 1.18.0 → 1.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +128 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-kendra.rb +2 -2
- data/lib/aws-sdk-kendra/client.rb +326 -18
- data/lib/aws-sdk-kendra/client_api.rb +178 -1
- data/lib/aws-sdk-kendra/errors.rb +1 -1
- data/lib/aws-sdk-kendra/resource.rb +1 -1
- data/lib/aws-sdk-kendra/types.rb +644 -43
- metadata +10 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 13ef9deb75aa3e25a0f22eb8f435dc97249bbb0a9c8620310bcbccae155309ce
|
|
4
|
+
data.tar.gz: 32b19f5f2b1295864ebc017073de00eded9ef29f7385db7ebe114d3b2d085143
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ed3c5d1d147b776e2b8e177b2f0de93dcb226d0cb8a56f1de887e33811fd85cb43dedf3c38121073c0130425450f72e3032b4eb352a3ec923a60a900c9565f1f
|
|
7
|
+
data.tar.gz: '0996fde8b0b7b298047a6a5d98e6d08d6b396288b9405c6f25be384cad828b34e073691f4857df3181624d4eecff36867457c1dad33199a3c4b6b477497d7c82'
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
Unreleased Changes
|
|
2
|
+
------------------
|
|
3
|
+
|
|
4
|
+
1.23.0 (2021-04-01)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - AWS Kendra's ServiceNow data source now supports OAuth 2.0 authentication and knowledge article filtering via a ServiceNow query.
|
|
8
|
+
|
|
9
|
+
1.22.0 (2021-03-10)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
13
|
+
|
|
14
|
+
1.21.0 (2021-02-02)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
18
|
+
|
|
19
|
+
1.20.0 (2020-12-10)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Amazon Kendra now supports adding synonyms to an index through the new Thesaurus resource.
|
|
23
|
+
|
|
24
|
+
1.19.0 (2020-12-08)
|
|
25
|
+
------------------
|
|
26
|
+
|
|
27
|
+
* Feature - 1. Amazon Kendra connector for Google Drive repositories 2. Amazon Kendra's relevance ranking models are regularly tuned for each customer by capturing end-user search patterns and feedback.
|
|
28
|
+
|
|
29
|
+
1.18.0 (2020-11-05)
|
|
30
|
+
------------------
|
|
31
|
+
|
|
32
|
+
* Feature - Amazon Kendra now supports providing user context in your query requests, Tokens can be JSON or JWT format. This release also introduces support for Confluence cloud datasources.
|
|
33
|
+
|
|
34
|
+
1.17.0 (2020-10-26)
|
|
35
|
+
------------------
|
|
36
|
+
|
|
37
|
+
* Feature - Amazon Kendra now supports indexing data from Confluence Server.
|
|
38
|
+
|
|
39
|
+
1.16.0 (2020-10-21)
|
|
40
|
+
------------------
|
|
41
|
+
|
|
42
|
+
* Feature - This release adds custom data sources: a new data source type that gives you full control of the documents added, modified or deleted during a data source sync while providing run history metrics.
|
|
43
|
+
|
|
44
|
+
1.15.0 (2020-10-21)
|
|
45
|
+
------------------
|
|
46
|
+
|
|
47
|
+
* Feature - This release adds custom data sources: a new data source type that gives you full control of the documents added, modified or deleted during a data source sync while providing run history metrics.
|
|
48
|
+
|
|
49
|
+
1.14.0 (2020-09-30)
|
|
50
|
+
------------------
|
|
51
|
+
|
|
52
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
53
|
+
|
|
54
|
+
1.13.0 (2020-09-17)
|
|
55
|
+
------------------
|
|
56
|
+
|
|
57
|
+
* Feature - Amazon Kendra now supports additional file formats and metadata for FAQs.
|
|
58
|
+
|
|
59
|
+
1.12.0 (2020-09-15)
|
|
60
|
+
------------------
|
|
61
|
+
|
|
62
|
+
* Feature - Amazon Kendra now returns confidence scores for 'document' query responses.
|
|
63
|
+
|
|
64
|
+
1.11.0 (2020-09-03)
|
|
65
|
+
------------------
|
|
66
|
+
|
|
67
|
+
* Feature - Amazon Kendra now returns confidence scores for both 'answer' and 'question and answer' query responses.
|
|
68
|
+
|
|
69
|
+
1.10.0 (2020-08-25)
|
|
70
|
+
------------------
|
|
71
|
+
|
|
72
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
73
|
+
|
|
74
|
+
1.9.0 (2020-07-24)
|
|
75
|
+
------------------
|
|
76
|
+
|
|
77
|
+
* Feature - Amazon Kendra now supports sorting query results based on document attributes. Amazon Kendra also introduced an option to enclose table and column names with double quotes for database data sources.
|
|
78
|
+
|
|
79
|
+
1.8.0 (2020-06-23)
|
|
80
|
+
------------------
|
|
81
|
+
|
|
82
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
83
|
+
|
|
84
|
+
1.7.1 (2020-06-11)
|
|
85
|
+
------------------
|
|
86
|
+
|
|
87
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
|
88
|
+
|
|
89
|
+
1.7.0 (2020-06-10)
|
|
90
|
+
------------------
|
|
91
|
+
|
|
92
|
+
* Issue - This version has been yanked. (#2327).
|
|
93
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
94
|
+
|
|
95
|
+
1.6.0 (2020-05-28)
|
|
96
|
+
------------------
|
|
97
|
+
|
|
98
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
99
|
+
|
|
100
|
+
1.5.0 (2020-05-11)
|
|
101
|
+
------------------
|
|
102
|
+
|
|
103
|
+
* Feature - Amazon Kendra is now generally available. As part of general availability, we are launching * Developer edition * Ability to scale your Amazon Kendra index with capacity units * Support for new connectors * Support for new tagging API's * Support for Deleting data source * Metrics for data source sync operations * Metrics for query & storage utilization
|
|
104
|
+
|
|
105
|
+
1.4.0 (2020-05-07)
|
|
106
|
+
------------------
|
|
107
|
+
|
|
108
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
109
|
+
|
|
110
|
+
1.3.0 (2020-03-27)
|
|
111
|
+
------------------
|
|
112
|
+
|
|
113
|
+
* Feature - The Amazon Kendra Microsoft SharePoint data source now supports include and exclude regular expressions and change log features. Include and exclude regular expressions enable you to provide a list of regular expressions to match the display URL of SharePoint documents to either include or exclude documents respectively. When you enable the changelog feature it enables Amazon Kendra to use the SharePoint change log to determine which documents to update in the index.
|
|
114
|
+
|
|
115
|
+
1.2.0 (2020-03-09)
|
|
116
|
+
------------------
|
|
117
|
+
|
|
118
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
119
|
+
|
|
120
|
+
1.1.0 (2019-12-10)
|
|
121
|
+
------------------
|
|
122
|
+
|
|
123
|
+
* Feature - 1. Adding DocumentTitleFieldName as an optional configuration for SharePoint. 2. updating s3 object pattern to support all s3 keys.
|
|
124
|
+
|
|
125
|
+
1.0.0 (2019-12-03)
|
|
126
|
+
------------------
|
|
127
|
+
|
|
128
|
+
* Feature - Initial release of `aws-sdk-kendra`.
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
1.23.0
|
data/lib/aws-sdk-kendra.rb
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
|
|
|
48
48
|
# @!group service
|
|
49
49
|
module Aws::Kendra
|
|
50
50
|
|
|
51
|
-
GEM_VERSION = '1.
|
|
51
|
+
GEM_VERSION = '1.23.0'
|
|
52
52
|
|
|
53
53
|
end
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
|
4
4
|
#
|
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
|
7
7
|
#
|
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
|
9
9
|
|
|
@@ -338,10 +338,10 @@ module Aws::Kendra
|
|
|
338
338
|
# @!group API Operations
|
|
339
339
|
|
|
340
340
|
# Removes one or more documents from an index. The documents must have
|
|
341
|
-
# been added with the BatchPutDocument operation.
|
|
341
|
+
# been added with the `BatchPutDocument` operation.
|
|
342
342
|
#
|
|
343
343
|
# The documents are deleted asynchronously. You can see the progress of
|
|
344
|
-
# the deletion by using AWS CloudWatch. Any error messages
|
|
344
|
+
# the deletion by using AWS CloudWatch. Any error messages related to
|
|
345
345
|
# the processing of the batch are sent to you CloudWatch log.
|
|
346
346
|
#
|
|
347
347
|
# @option params [required, String] :index_id
|
|
@@ -398,7 +398,7 @@ module Aws::Kendra
|
|
|
398
398
|
#
|
|
399
399
|
# @option params [required, String] :index_id
|
|
400
400
|
# The identifier of the index to add the documents to. You need to
|
|
401
|
-
# create the index first using the CreateIndex operation.
|
|
401
|
+
# create the index first using the `CreateIndex` operation.
|
|
402
402
|
#
|
|
403
403
|
# @option params [String] :role_arn
|
|
404
404
|
# The Amazon Resource Name (ARN) of a role that is allowed to run the
|
|
@@ -566,7 +566,7 @@ module Aws::Kendra
|
|
|
566
566
|
# resp = client.create_data_source({
|
|
567
567
|
# name: "DataSourceName", # required
|
|
568
568
|
# index_id: "IndexId", # required
|
|
569
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
|
569
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE
|
|
570
570
|
# configuration: {
|
|
571
571
|
# s3_configuration: {
|
|
572
572
|
# bucket_name: "S3BucketName", # required
|
|
@@ -744,6 +744,7 @@ module Aws::Kendra
|
|
|
744
744
|
# index_field_name: "IndexFieldName", # required
|
|
745
745
|
# },
|
|
746
746
|
# ],
|
|
747
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
|
747
748
|
# },
|
|
748
749
|
# service_catalog_configuration: {
|
|
749
750
|
# crawl_attachments: false,
|
|
@@ -759,6 +760,7 @@ module Aws::Kendra
|
|
|
759
760
|
# },
|
|
760
761
|
# ],
|
|
761
762
|
# },
|
|
763
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
|
762
764
|
# },
|
|
763
765
|
# confluence_configuration: {
|
|
764
766
|
# server_url: "Url", # required
|
|
@@ -812,6 +814,21 @@ module Aws::Kendra
|
|
|
812
814
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
813
815
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
814
816
|
# },
|
|
817
|
+
# google_drive_configuration: {
|
|
818
|
+
# secret_arn: "SecretArn", # required
|
|
819
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
820
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
821
|
+
# field_mappings: [
|
|
822
|
+
# {
|
|
823
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
824
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
825
|
+
# index_field_name: "IndexFieldName", # required
|
|
826
|
+
# },
|
|
827
|
+
# ],
|
|
828
|
+
# exclude_mime_types: ["MimeType"],
|
|
829
|
+
# exclude_user_accounts: ["UserAccount"],
|
|
830
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
|
831
|
+
# },
|
|
815
832
|
# },
|
|
816
833
|
# description: "Description",
|
|
817
834
|
# schedule: "ScanSchedule",
|
|
@@ -929,11 +946,12 @@ module Aws::Kendra
|
|
|
929
946
|
|
|
930
947
|
# Creates a new Amazon Kendra index. Index creation is an asynchronous
|
|
931
948
|
# operation. To determine if index creation has completed, check the
|
|
932
|
-
# `Status` field returned from a call to
|
|
933
|
-
# `ACTIVE` when the index is ready to use.
|
|
949
|
+
# `Status` field returned from a call to `DescribeIndex`. The `Status`
|
|
950
|
+
# field is set to `ACTIVE` when the index is ready to use.
|
|
934
951
|
#
|
|
935
952
|
# Once the index is active you can index your documents using the
|
|
936
|
-
# operation or using one of the supported data
|
|
953
|
+
# `BatchPutDocument` operation or using one of the supported data
|
|
954
|
+
# sources.
|
|
937
955
|
#
|
|
938
956
|
# @option params [required, String] :name
|
|
939
957
|
# The name for the new index.
|
|
@@ -1047,11 +1065,81 @@ module Aws::Kendra
|
|
|
1047
1065
|
req.send_request(options)
|
|
1048
1066
|
end
|
|
1049
1067
|
|
|
1068
|
+
# Creates a thesaurus for an index. The thesaurus contains a list of
|
|
1069
|
+
# synonyms in Solr format.
|
|
1070
|
+
#
|
|
1071
|
+
# @option params [required, String] :index_id
|
|
1072
|
+
# The unique identifier of the index for the new thesaurus.
|
|
1073
|
+
#
|
|
1074
|
+
# @option params [required, String] :name
|
|
1075
|
+
# The name for the new thesaurus.
|
|
1076
|
+
#
|
|
1077
|
+
# @option params [String] :description
|
|
1078
|
+
# The description for the new thesaurus.
|
|
1079
|
+
#
|
|
1080
|
+
# @option params [required, String] :role_arn
|
|
1081
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
|
1082
|
+
# Kendra permissions to access thesaurus file specified in
|
|
1083
|
+
# `SourceS3Path`.
|
|
1084
|
+
#
|
|
1085
|
+
# @option params [Array<Types::Tag>] :tags
|
|
1086
|
+
# A list of key-value pairs that identify the thesaurus. You can use the
|
|
1087
|
+
# tags to identify and organize your resources and to control access to
|
|
1088
|
+
# resources.
|
|
1089
|
+
#
|
|
1090
|
+
# @option params [required, Types::S3Path] :source_s3_path
|
|
1091
|
+
# The thesaurus file Amazon S3 source path.
|
|
1092
|
+
#
|
|
1093
|
+
# @option params [String] :client_token
|
|
1094
|
+
# A token that you provide to identify the request to create a
|
|
1095
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` operation with the
|
|
1096
|
+
# same client token will create only one index.
|
|
1097
|
+
#
|
|
1098
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1099
|
+
# not need to pass this option.**
|
|
1100
|
+
#
|
|
1101
|
+
# @return [Types::CreateThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1102
|
+
#
|
|
1103
|
+
# * {Types::CreateThesaurusResponse#id #id} => String
|
|
1104
|
+
#
|
|
1105
|
+
# @example Request syntax with placeholder values
|
|
1106
|
+
#
|
|
1107
|
+
# resp = client.create_thesaurus({
|
|
1108
|
+
# index_id: "IndexId", # required
|
|
1109
|
+
# name: "ThesaurusName", # required
|
|
1110
|
+
# description: "Description",
|
|
1111
|
+
# role_arn: "RoleArn", # required
|
|
1112
|
+
# tags: [
|
|
1113
|
+
# {
|
|
1114
|
+
# key: "TagKey", # required
|
|
1115
|
+
# value: "TagValue", # required
|
|
1116
|
+
# },
|
|
1117
|
+
# ],
|
|
1118
|
+
# source_s3_path: { # required
|
|
1119
|
+
# bucket: "S3BucketName", # required
|
|
1120
|
+
# key: "S3ObjectKey", # required
|
|
1121
|
+
# },
|
|
1122
|
+
# client_token: "ClientTokenName",
|
|
1123
|
+
# })
|
|
1124
|
+
#
|
|
1125
|
+
# @example Response structure
|
|
1126
|
+
#
|
|
1127
|
+
# resp.id #=> String
|
|
1128
|
+
#
|
|
1129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateThesaurus AWS API Documentation
|
|
1130
|
+
#
|
|
1131
|
+
# @overload create_thesaurus(params = {})
|
|
1132
|
+
# @param [Hash] params ({})
|
|
1133
|
+
def create_thesaurus(params = {}, options = {})
|
|
1134
|
+
req = build_request(:create_thesaurus, params)
|
|
1135
|
+
req.send_request(options)
|
|
1136
|
+
end
|
|
1137
|
+
|
|
1050
1138
|
# Deletes an Amazon Kendra data source. An exception is not thrown if
|
|
1051
1139
|
# the data source is already being deleted. While the data source is
|
|
1052
|
-
# being deleted, the `Status` field returned by a call to the
|
|
1053
|
-
# is set to `DELETING`. For more
|
|
1054
|
-
# Sources][1].
|
|
1140
|
+
# being deleted, the `Status` field returned by a call to the
|
|
1141
|
+
# `DescribeDataSource` operation is set to `DELETING`. For more
|
|
1142
|
+
# information, see [Deleting Data Sources][1].
|
|
1055
1143
|
#
|
|
1056
1144
|
#
|
|
1057
1145
|
#
|
|
@@ -1109,7 +1197,7 @@ module Aws::Kendra
|
|
|
1109
1197
|
|
|
1110
1198
|
# Deletes an existing Amazon Kendra index. An exception is not thrown if
|
|
1111
1199
|
# the index is already being deleted. While the index is being deleted,
|
|
1112
|
-
# the `Status` field returned by a call to the DescribeIndex operation
|
|
1200
|
+
# the `Status` field returned by a call to the `DescribeIndex` operation
|
|
1113
1201
|
# is set to `DELETING`.
|
|
1114
1202
|
#
|
|
1115
1203
|
# @option params [required, String] :id
|
|
@@ -1132,6 +1220,32 @@ module Aws::Kendra
|
|
|
1132
1220
|
req.send_request(options)
|
|
1133
1221
|
end
|
|
1134
1222
|
|
|
1223
|
+
# Deletes an existing Amazon Kendra thesaurus.
|
|
1224
|
+
#
|
|
1225
|
+
# @option params [required, String] :id
|
|
1226
|
+
# The identifier of the thesaurus to delete.
|
|
1227
|
+
#
|
|
1228
|
+
# @option params [required, String] :index_id
|
|
1229
|
+
# The identifier of the index associated with the thesaurus to delete.
|
|
1230
|
+
#
|
|
1231
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1232
|
+
#
|
|
1233
|
+
# @example Request syntax with placeholder values
|
|
1234
|
+
#
|
|
1235
|
+
# resp = client.delete_thesaurus({
|
|
1236
|
+
# id: "ThesaurusId", # required
|
|
1237
|
+
# index_id: "IndexId", # required
|
|
1238
|
+
# })
|
|
1239
|
+
#
|
|
1240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurus AWS API Documentation
|
|
1241
|
+
#
|
|
1242
|
+
# @overload delete_thesaurus(params = {})
|
|
1243
|
+
# @param [Hash] params ({})
|
|
1244
|
+
def delete_thesaurus(params = {}, options = {})
|
|
1245
|
+
req = build_request(:delete_thesaurus, params)
|
|
1246
|
+
req.send_request(options)
|
|
1247
|
+
end
|
|
1248
|
+
|
|
1135
1249
|
# Gets information about a Amazon Kendra data source.
|
|
1136
1250
|
#
|
|
1137
1251
|
# @option params [required, String] :id
|
|
@@ -1167,7 +1281,7 @@ module Aws::Kendra
|
|
|
1167
1281
|
# resp.id #=> String
|
|
1168
1282
|
# resp.index_id #=> String
|
|
1169
1283
|
# resp.name #=> String
|
|
1170
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
|
1284
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
|
1171
1285
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
|
1172
1286
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
|
1173
1287
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
|
@@ -1291,6 +1405,7 @@ module Aws::Kendra
|
|
|
1291
1405
|
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].data_source_field_name #=> String
|
|
1292
1406
|
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].date_field_format #=> String
|
|
1293
1407
|
# resp.configuration.service_now_configuration.knowledge_article_configuration.field_mappings[0].index_field_name #=> String
|
|
1408
|
+
# resp.configuration.service_now_configuration.knowledge_article_configuration.filter_query #=> String
|
|
1294
1409
|
# resp.configuration.service_now_configuration.service_catalog_configuration.crawl_attachments #=> Boolean
|
|
1295
1410
|
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns #=> Array
|
|
1296
1411
|
# resp.configuration.service_now_configuration.service_catalog_configuration.include_attachment_file_patterns[0] #=> String
|
|
@@ -1302,6 +1417,7 @@ module Aws::Kendra
|
|
|
1302
1417
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
|
1303
1418
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
|
1304
1419
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
|
1420
|
+
# resp.configuration.service_now_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
|
|
1305
1421
|
# resp.configuration.confluence_configuration.server_url #=> String
|
|
1306
1422
|
# resp.configuration.confluence_configuration.secret_arn #=> String
|
|
1307
1423
|
# resp.configuration.confluence_configuration.version #=> String, one of "CLOUD", "SERVER"
|
|
@@ -1336,6 +1452,21 @@ module Aws::Kendra
|
|
|
1336
1452
|
# resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
|
|
1337
1453
|
# resp.configuration.confluence_configuration.exclusion_patterns #=> Array
|
|
1338
1454
|
# resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
|
|
1455
|
+
# resp.configuration.google_drive_configuration.secret_arn #=> String
|
|
1456
|
+
# resp.configuration.google_drive_configuration.inclusion_patterns #=> Array
|
|
1457
|
+
# resp.configuration.google_drive_configuration.inclusion_patterns[0] #=> String
|
|
1458
|
+
# resp.configuration.google_drive_configuration.exclusion_patterns #=> Array
|
|
1459
|
+
# resp.configuration.google_drive_configuration.exclusion_patterns[0] #=> String
|
|
1460
|
+
# resp.configuration.google_drive_configuration.field_mappings #=> Array
|
|
1461
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].data_source_field_name #=> String
|
|
1462
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].date_field_format #=> String
|
|
1463
|
+
# resp.configuration.google_drive_configuration.field_mappings[0].index_field_name #=> String
|
|
1464
|
+
# resp.configuration.google_drive_configuration.exclude_mime_types #=> Array
|
|
1465
|
+
# resp.configuration.google_drive_configuration.exclude_mime_types[0] #=> String
|
|
1466
|
+
# resp.configuration.google_drive_configuration.exclude_user_accounts #=> Array
|
|
1467
|
+
# resp.configuration.google_drive_configuration.exclude_user_accounts[0] #=> String
|
|
1468
|
+
# resp.configuration.google_drive_configuration.exclude_shared_drives #=> Array
|
|
1469
|
+
# resp.configuration.google_drive_configuration.exclude_shared_drives[0] #=> String
|
|
1339
1470
|
# resp.created_at #=> Time
|
|
1340
1471
|
# resp.updated_at #=> Time
|
|
1341
1472
|
# resp.description #=> String
|
|
@@ -1486,6 +1617,63 @@ module Aws::Kendra
|
|
|
1486
1617
|
req.send_request(options)
|
|
1487
1618
|
end
|
|
1488
1619
|
|
|
1620
|
+
# Describes an existing Amazon Kendra thesaurus.
|
|
1621
|
+
#
|
|
1622
|
+
# @option params [required, String] :id
|
|
1623
|
+
# The identifier of the thesaurus to describe.
|
|
1624
|
+
#
|
|
1625
|
+
# @option params [required, String] :index_id
|
|
1626
|
+
# The identifier of the index associated with the thesaurus to describe.
|
|
1627
|
+
#
|
|
1628
|
+
# @return [Types::DescribeThesaurusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1629
|
+
#
|
|
1630
|
+
# * {Types::DescribeThesaurusResponse#id #id} => String
|
|
1631
|
+
# * {Types::DescribeThesaurusResponse#index_id #index_id} => String
|
|
1632
|
+
# * {Types::DescribeThesaurusResponse#name #name} => String
|
|
1633
|
+
# * {Types::DescribeThesaurusResponse#description #description} => String
|
|
1634
|
+
# * {Types::DescribeThesaurusResponse#status #status} => String
|
|
1635
|
+
# * {Types::DescribeThesaurusResponse#error_message #error_message} => String
|
|
1636
|
+
# * {Types::DescribeThesaurusResponse#created_at #created_at} => Time
|
|
1637
|
+
# * {Types::DescribeThesaurusResponse#updated_at #updated_at} => Time
|
|
1638
|
+
# * {Types::DescribeThesaurusResponse#role_arn #role_arn} => String
|
|
1639
|
+
# * {Types::DescribeThesaurusResponse#source_s3_path #source_s3_path} => Types::S3Path
|
|
1640
|
+
# * {Types::DescribeThesaurusResponse#file_size_bytes #file_size_bytes} => Integer
|
|
1641
|
+
# * {Types::DescribeThesaurusResponse#term_count #term_count} => Integer
|
|
1642
|
+
# * {Types::DescribeThesaurusResponse#synonym_rule_count #synonym_rule_count} => Integer
|
|
1643
|
+
#
|
|
1644
|
+
# @example Request syntax with placeholder values
|
|
1645
|
+
#
|
|
1646
|
+
# resp = client.describe_thesaurus({
|
|
1647
|
+
# id: "ThesaurusId", # required
|
|
1648
|
+
# index_id: "IndexId", # required
|
|
1649
|
+
# })
|
|
1650
|
+
#
|
|
1651
|
+
# @example Response structure
|
|
1652
|
+
#
|
|
1653
|
+
# resp.id #=> String
|
|
1654
|
+
# resp.index_id #=> String
|
|
1655
|
+
# resp.name #=> String
|
|
1656
|
+
# resp.description #=> String
|
|
1657
|
+
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
|
1658
|
+
# resp.error_message #=> String
|
|
1659
|
+
# resp.created_at #=> Time
|
|
1660
|
+
# resp.updated_at #=> Time
|
|
1661
|
+
# resp.role_arn #=> String
|
|
1662
|
+
# resp.source_s3_path.bucket #=> String
|
|
1663
|
+
# resp.source_s3_path.key #=> String
|
|
1664
|
+
# resp.file_size_bytes #=> Integer
|
|
1665
|
+
# resp.term_count #=> Integer
|
|
1666
|
+
# resp.synonym_rule_count #=> Integer
|
|
1667
|
+
#
|
|
1668
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurus AWS API Documentation
|
|
1669
|
+
#
|
|
1670
|
+
# @overload describe_thesaurus(params = {})
|
|
1671
|
+
# @param [Hash] params ({})
|
|
1672
|
+
def describe_thesaurus(params = {}, options = {})
|
|
1673
|
+
req = build_request(:describe_thesaurus, params)
|
|
1674
|
+
req.send_request(options)
|
|
1675
|
+
end
|
|
1676
|
+
|
|
1489
1677
|
# Gets statistics about synchronizing Amazon Kendra with a data source.
|
|
1490
1678
|
#
|
|
1491
1679
|
# @option params [required, String] :id
|
|
@@ -1592,7 +1780,7 @@ module Aws::Kendra
|
|
|
1592
1780
|
# resp.summary_items #=> Array
|
|
1593
1781
|
# resp.summary_items[0].name #=> String
|
|
1594
1782
|
# resp.summary_items[0].id #=> String
|
|
1595
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
|
1783
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE"
|
|
1596
1784
|
# resp.summary_items[0].created_at #=> Time
|
|
1597
1785
|
# resp.summary_items[0].updated_at #=> Time
|
|
1598
1786
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
|
@@ -1731,6 +1919,52 @@ module Aws::Kendra
|
|
|
1731
1919
|
req.send_request(options)
|
|
1732
1920
|
end
|
|
1733
1921
|
|
|
1922
|
+
# Lists the Amazon Kendra thesauri associated with an index.
|
|
1923
|
+
#
|
|
1924
|
+
# @option params [required, String] :index_id
|
|
1925
|
+
# The identifier of the index associated with the thesaurus to list.
|
|
1926
|
+
#
|
|
1927
|
+
# @option params [String] :next_token
|
|
1928
|
+
# If the previous response was incomplete (because there is more data to
|
|
1929
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
|
1930
|
+
# You can use this pagination token to retrieve the next set of thesauri
|
|
1931
|
+
# (`ThesaurusSummaryItems`).
|
|
1932
|
+
#
|
|
1933
|
+
# @option params [Integer] :max_results
|
|
1934
|
+
# The maximum number of thesauri to return.
|
|
1935
|
+
#
|
|
1936
|
+
# @return [Types::ListThesauriResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1937
|
+
#
|
|
1938
|
+
# * {Types::ListThesauriResponse#next_token #next_token} => String
|
|
1939
|
+
# * {Types::ListThesauriResponse#thesaurus_summary_items #thesaurus_summary_items} => Array<Types::ThesaurusSummary>
|
|
1940
|
+
#
|
|
1941
|
+
# @example Request syntax with placeholder values
|
|
1942
|
+
#
|
|
1943
|
+
# resp = client.list_thesauri({
|
|
1944
|
+
# index_id: "IndexId", # required
|
|
1945
|
+
# next_token: "NextToken",
|
|
1946
|
+
# max_results: 1,
|
|
1947
|
+
# })
|
|
1948
|
+
#
|
|
1949
|
+
# @example Response structure
|
|
1950
|
+
#
|
|
1951
|
+
# resp.next_token #=> String
|
|
1952
|
+
# resp.thesaurus_summary_items #=> Array
|
|
1953
|
+
# resp.thesaurus_summary_items[0].id #=> String
|
|
1954
|
+
# resp.thesaurus_summary_items[0].name #=> String
|
|
1955
|
+
# resp.thesaurus_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "ACTIVE_BUT_UPDATE_FAILED", "FAILED"
|
|
1956
|
+
# resp.thesaurus_summary_items[0].created_at #=> Time
|
|
1957
|
+
# resp.thesaurus_summary_items[0].updated_at #=> Time
|
|
1958
|
+
#
|
|
1959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauri AWS API Documentation
|
|
1960
|
+
#
|
|
1961
|
+
# @overload list_thesauri(params = {})
|
|
1962
|
+
# @param [Hash] params ({})
|
|
1963
|
+
def list_thesauri(params = {}, options = {})
|
|
1964
|
+
req = build_request(:list_thesauri, params)
|
|
1965
|
+
req.send_request(options)
|
|
1966
|
+
end
|
|
1967
|
+
|
|
1734
1968
|
# Searches an active index. Use this API to search your documents using
|
|
1735
1969
|
# query. The `Query` operation enables to do faceted search and to
|
|
1736
1970
|
# filter results based on document attributes.
|
|
@@ -1755,7 +1989,7 @@ module Aws::Kendra
|
|
|
1755
1989
|
#
|
|
1756
1990
|
# @option params [required, String] :index_id
|
|
1757
1991
|
# The unique identifier of the index to search. The identifier is
|
|
1758
|
-
# returned in the response from the operation.
|
|
1992
|
+
# returned in the response from the `CreateIndex` operation.
|
|
1759
1993
|
#
|
|
1760
1994
|
# @option params [required, String] :query_text
|
|
1761
1995
|
# The text to search for.
|
|
@@ -1807,6 +2041,12 @@ module Aws::Kendra
|
|
|
1807
2041
|
# @option params [Types::UserContext] :user_context
|
|
1808
2042
|
# The user context token.
|
|
1809
2043
|
#
|
|
2044
|
+
# @option params [String] :visitor_id
|
|
2045
|
+
# Provides an identifier for a specific user. The `VisitorId` should be
|
|
2046
|
+
# a unique identifier, such as a GUID. Don't use personally
|
|
2047
|
+
# identifiable information, such as the user's email address, as the
|
|
2048
|
+
# `VisitorId`.
|
|
2049
|
+
#
|
|
1810
2050
|
# @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1811
2051
|
#
|
|
1812
2052
|
# * {Types::QueryResult#query_id #query_id} => String
|
|
@@ -1913,6 +2153,7 @@ module Aws::Kendra
|
|
|
1913
2153
|
# user_context: {
|
|
1914
2154
|
# token: "Token",
|
|
1915
2155
|
# },
|
|
2156
|
+
# visitor_id: "VisitorId",
|
|
1916
2157
|
# })
|
|
1917
2158
|
#
|
|
1918
2159
|
# @example Response structure
|
|
@@ -1929,17 +2170,20 @@ module Aws::Kendra
|
|
|
1929
2170
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].begin_offset #=> Integer
|
|
1930
2171
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].end_offset #=> Integer
|
|
1931
2172
|
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].top_answer #=> Boolean
|
|
2173
|
+
# resp.result_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
|
1932
2174
|
# resp.result_items[0].document_id #=> String
|
|
1933
2175
|
# resp.result_items[0].document_title.text #=> String
|
|
1934
2176
|
# resp.result_items[0].document_title.highlights #=> Array
|
|
1935
2177
|
# resp.result_items[0].document_title.highlights[0].begin_offset #=> Integer
|
|
1936
2178
|
# resp.result_items[0].document_title.highlights[0].end_offset #=> Integer
|
|
1937
2179
|
# resp.result_items[0].document_title.highlights[0].top_answer #=> Boolean
|
|
2180
|
+
# resp.result_items[0].document_title.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
|
1938
2181
|
# resp.result_items[0].document_excerpt.text #=> String
|
|
1939
2182
|
# resp.result_items[0].document_excerpt.highlights #=> Array
|
|
1940
2183
|
# resp.result_items[0].document_excerpt.highlights[0].begin_offset #=> Integer
|
|
1941
2184
|
# resp.result_items[0].document_excerpt.highlights[0].end_offset #=> Integer
|
|
1942
2185
|
# resp.result_items[0].document_excerpt.highlights[0].top_answer #=> Boolean
|
|
2186
|
+
# resp.result_items[0].document_excerpt.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
|
|
1943
2187
|
# resp.result_items[0].document_uri #=> String
|
|
1944
2188
|
# resp.result_items[0].document_attributes #=> Array
|
|
1945
2189
|
# resp.result_items[0].document_attributes[0].key #=> String
|
|
@@ -1949,6 +2193,7 @@ module Aws::Kendra
|
|
|
1949
2193
|
# resp.result_items[0].document_attributes[0].value.long_value #=> Integer
|
|
1950
2194
|
# resp.result_items[0].document_attributes[0].value.date_value #=> Time
|
|
1951
2195
|
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
|
|
2196
|
+
# resp.result_items[0].feedback_token #=> String
|
|
1952
2197
|
# resp.facet_results #=> Array
|
|
1953
2198
|
# resp.facet_results[0].document_attribute_key #=> String
|
|
1954
2199
|
# resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
|
|
@@ -2040,7 +2285,8 @@ module Aws::Kendra
|
|
|
2040
2285
|
#
|
|
2041
2286
|
# @option params [required, String] :query_id
|
|
2042
2287
|
# The identifier of the specific query for which you are submitting
|
|
2043
|
-
# feedback. The query ID is returned in the response to the
|
|
2288
|
+
# feedback. The query ID is returned in the response to the `Query`
|
|
2289
|
+
# operation.
|
|
2044
2290
|
#
|
|
2045
2291
|
# @option params [Array<Types::ClickFeedback>] :click_feedback_items
|
|
2046
2292
|
# Tells Amazon Kendra that a particular search result link was chosen by
|
|
@@ -2354,6 +2600,7 @@ module Aws::Kendra
|
|
|
2354
2600
|
# index_field_name: "IndexFieldName", # required
|
|
2355
2601
|
# },
|
|
2356
2602
|
# ],
|
|
2603
|
+
# filter_query: "ServiceNowKnowledgeArticleFilterQuery",
|
|
2357
2604
|
# },
|
|
2358
2605
|
# service_catalog_configuration: {
|
|
2359
2606
|
# crawl_attachments: false,
|
|
@@ -2369,6 +2616,7 @@ module Aws::Kendra
|
|
|
2369
2616
|
# },
|
|
2370
2617
|
# ],
|
|
2371
2618
|
# },
|
|
2619
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
|
2372
2620
|
# },
|
|
2373
2621
|
# confluence_configuration: {
|
|
2374
2622
|
# server_url: "Url", # required
|
|
@@ -2422,6 +2670,21 @@ module Aws::Kendra
|
|
|
2422
2670
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2423
2671
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2424
2672
|
# },
|
|
2673
|
+
# google_drive_configuration: {
|
|
2674
|
+
# secret_arn: "SecretArn", # required
|
|
2675
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2676
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2677
|
+
# field_mappings: [
|
|
2678
|
+
# {
|
|
2679
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2680
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2681
|
+
# index_field_name: "IndexFieldName", # required
|
|
2682
|
+
# },
|
|
2683
|
+
# ],
|
|
2684
|
+
# exclude_mime_types: ["MimeType"],
|
|
2685
|
+
# exclude_user_accounts: ["UserAccount"],
|
|
2686
|
+
# exclude_shared_drives: ["SharedDriveId"],
|
|
2687
|
+
# },
|
|
2425
2688
|
# },
|
|
2426
2689
|
# description: "Description",
|
|
2427
2690
|
# schedule: "ScanSchedule",
|
|
@@ -2456,7 +2719,7 @@ module Aws::Kendra
|
|
|
2456
2719
|
# The document metadata to update.
|
|
2457
2720
|
#
|
|
2458
2721
|
# @option params [Types::CapacityUnitsConfiguration] :capacity_units
|
|
2459
|
-
# Sets the number of
|
|
2722
|
+
# Sets the number of additional storage and query capacity units that
|
|
2460
2723
|
# should be used by the index. You can change the capacity of the index
|
|
2461
2724
|
# up to 5 times per day.
|
|
2462
2725
|
#
|
|
@@ -2532,6 +2795,51 @@ module Aws::Kendra
|
|
|
2532
2795
|
req.send_request(options)
|
|
2533
2796
|
end
|
|
2534
2797
|
|
|
2798
|
+
# Updates a thesaurus file associated with an index.
|
|
2799
|
+
#
|
|
2800
|
+
# @option params [required, String] :id
|
|
2801
|
+
# The identifier of the thesaurus to update.
|
|
2802
|
+
#
|
|
2803
|
+
# @option params [String] :name
|
|
2804
|
+
# The updated name of the thesaurus.
|
|
2805
|
+
#
|
|
2806
|
+
# @option params [required, String] :index_id
|
|
2807
|
+
# The identifier of the index associated with the thesaurus to update.
|
|
2808
|
+
#
|
|
2809
|
+
# @option params [String] :description
|
|
2810
|
+
# The updated description of the thesaurus.
|
|
2811
|
+
#
|
|
2812
|
+
# @option params [String] :role_arn
|
|
2813
|
+
# The updated role ARN of the thesaurus.
|
|
2814
|
+
#
|
|
2815
|
+
# @option params [Types::S3Path] :source_s3_path
|
|
2816
|
+
# Information required to find a specific file in an Amazon S3 bucket.
|
|
2817
|
+
#
|
|
2818
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
2819
|
+
#
|
|
2820
|
+
# @example Request syntax with placeholder values
|
|
2821
|
+
#
|
|
2822
|
+
# resp = client.update_thesaurus({
|
|
2823
|
+
# id: "ThesaurusId", # required
|
|
2824
|
+
# name: "ThesaurusName",
|
|
2825
|
+
# index_id: "IndexId", # required
|
|
2826
|
+
# description: "Description",
|
|
2827
|
+
# role_arn: "RoleArn",
|
|
2828
|
+
# source_s3_path: {
|
|
2829
|
+
# bucket: "S3BucketName", # required
|
|
2830
|
+
# key: "S3ObjectKey", # required
|
|
2831
|
+
# },
|
|
2832
|
+
# })
|
|
2833
|
+
#
|
|
2834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateThesaurus AWS API Documentation
|
|
2835
|
+
#
|
|
2836
|
+
# @overload update_thesaurus(params = {})
|
|
2837
|
+
# @param [Hash] params ({})
|
|
2838
|
+
def update_thesaurus(params = {}, options = {})
|
|
2839
|
+
req = build_request(:update_thesaurus, params)
|
|
2840
|
+
req.send_request(options)
|
|
2841
|
+
end
|
|
2842
|
+
|
|
2535
2843
|
# @!endgroup
|
|
2536
2844
|
|
|
2537
2845
|
# @param params ({})
|
|
@@ -2545,7 +2853,7 @@ module Aws::Kendra
|
|
|
2545
2853
|
params: params,
|
|
2546
2854
|
config: config)
|
|
2547
2855
|
context[:gem_name] = 'aws-sdk-kendra'
|
|
2548
|
-
context[:gem_version] = '1.
|
|
2856
|
+
context[:gem_version] = '1.23.0'
|
|
2549
2857
|
Seahorse::Client::Request.new(handlers, context)
|
|
2550
2858
|
end
|
|
2551
2859
|
|