Ingesting Documents

If you are using the APIs directly, choose from one of the following methods.

ingest_remote

Ingest documents hosted on public URLs into a GroundX bucket.

ingest_local

Upload documents hosted on a local file system into a GroundX bucket.

If you are using one of the supported SDKs, the ingest method can be used to ingest both local and remote documents.

Document

bucketId
integerRequired

The bucketId of the bucket which this file will be ingested to.

filePath
stringRequired

The local file path or remote URL of the document being ingested by GroundX.

fileName
string

The name of the file being ingested.

fileType
enum

The type of document (one of the currently supported file types).

searchData
object

Custom metadata which can be used to influence GroundX’s search functionality. This data can be used to further hone GroundX search.