Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AddDocumentParams

Parameters for the addDocument operation.

Hierarchy

  • AddDocumentParams

Index

Properties

Properties

collectionId

collectionId: string

The ID of the collection.

environmentId

environmentId: string

The ID of the environment.

Optional file

file: ReadableStream | Buffer

The content of the document to ingest. The maximum supported file size when adding a file to a collection is 50 megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the supported size are rejected.

Optional fileContentType

fileContentType: FileContentType | string

The content type of file.

Optional filename

filename: string

The filename for file.

Optional headers

headers: OutgoingHttpHeaders

Optional metadata

metadata: string

The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. Example:

{ "Creator": "Johnny Appleseed", "Subject": "Apples" }.

Generated using TypeDoc