Class: Aws::Kendra::Types::Document
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::Document
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-kendra/types.rb
Overview
A document in an index.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#access_control_configuration_id ⇒ String
The identifier of the access control configuration that you want to apply to the document.
-
#access_control_list ⇒ Array<Types::Principal>
Information on principals (users and/or groups) and which documents they should have access to.
-
#attributes ⇒ Array<Types::DocumentAttribute>
Custom attributes to apply to the document.
-
#blob ⇒ String
The contents of the document.
-
#content_type ⇒ String
The file type of the document in the ‘Blob` field.
-
#hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>
The list of [principal] lists that define the hierarchy for which documents users should have access to.
-
#id ⇒ String
A identifier of the document in the index.
-
#s3_path ⇒ Types::S3Path
Information required to find a specific file in an Amazon S3 bucket.
-
#title ⇒ String
The title of the document.
Instance Attribute Details
#access_control_configuration_id ⇒ String
The identifier of the access control configuration that you want to apply to the document.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#access_control_list ⇒ Array<Types::Principal>
Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#attributes ⇒ Array<Types::DocumentAttribute>
Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
For example, ‘DataSourceId’ and ‘DataSourceSyncJobId’ are custom attributes that provide information on the synchronization of documents running on a data source. Note, ‘DataSourceSyncJobId’ could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#blob ⇒ String
The contents of the document.
Documents passed to the ‘Blob` parameter must be base64 encoded. Your code might not need to encode the document file bytes if you’re using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#content_type ⇒ String
The file type of the document in the ‘Blob` field.
If you want to index snippets or subsets of HTML documents instead of the entirety of the HTML documents, you must add the ‘HTML` start and closing tags (`<HTML>content</HTML>`) around the content.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#hierarchical_access_control_list ⇒ Array<Types::HierarchicalPrincipal>
The list of [principal] lists that define the hierarchy for which documents users should have access to.
[1]: docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
A identifier of the document in the index.
Note, each document ID must be unique per index. You cannot create a data source to index your documents with their unique IDs and then use the ‘BatchPutDocument` API to index the same documents, or vice versa. You can delete a data source and then use the `BatchPutDocument` API to index the same documents, or vice versa.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#s3_path ⇒ Types::S3Path
Information required to find a specific file in an Amazon S3 bucket.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |
#title ⇒ String
The title of the document.
4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 |
# File 'lib/aws-sdk-kendra/types.rb', line 4492 class Document < Struct.new( :id, :title, :blob, :s3_path, :attributes, :access_control_list, :hierarchical_access_control_list, :content_type, :access_control_configuration_id) SENSITIVE = [] include Aws::Structure end |