Document
import type { Document } from "https://aws-api.deno.dev/v0.3/services/kendra.ts?docs=full";
A document in an index.
interface Document {
AccessControlList?: Principal[] | null;
Attributes?: DocumentAttribute[] | null;
Blob?: Uint8Array | string | null;
ContentType?: ContentType | null;
HierarchicalAccessControlList?: HierarchicalPrincipal[] | null;
Id: string;
S3Path?: S3Path | null;
Title?: string | null;
}§Properties
§
Attributes?: DocumentAttribute[] | null
[src]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.
§
Blob?: Uint8Array | string | null
[src]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 operations.
If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.
§
ContentType?: ContentType | null
[src]The file type of the document in the Blob
field.
§
HierarchicalAccessControlList?: HierarchicalPrincipal[] | null
[src]The list of principal lists that define the hierarchy for which documents users should have access to.