options for the initialization of a client.
Deletes a document from the RAG database.
the product the RAG database belongs to.
the document's ID.
Send a file to the asynchronous processing queue for inference.
Send a file to the inference queue and return the results when complete.
the product to retrieve.
file or URL to parse.
parameters relating to prediction options.
OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
options for the polling loop, see PollingOptions.
a Promise containing parsing results.
Get the status of an inference that was previously enqueued.
Prefer using getJobByUrl using the polling URL returned by the enqueue method.
id of the queue to poll.
a Promise containing a Job, which also contains a Document if the
parsing is complete.
Get the status of an inference that was previously enqueued. Can be used for polling.
The URL to poll to retrieve the job.
a Promise containing a Job, which also contains a Document if the
parsing is complete.
Not recommended for general use, prefer getReadyRagDocumentPoll.
You will need to poll until the document is ready for use.
Get a document's info and annotations from the RAG database.
the product the RAG database belongs to.
the document's ID.
Get a document's info and annotations from the RAG database.
the product the RAG database belongs to.
the document's ID.
OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
options for the polling loop, see PollingOptions.
a Promise containing the RAG document annotation.
Get the result of an inference that was previously enqueued.
Prefer using getResultByUrl using the result URL returned in the Job instance.
the product to retrieve.
id of the queue to poll.
a Promise containing the inference.
ProtectedpollProtected
Poll until the inference is finished processing or the max number of attempts is reached.
ProtectedpollProtected
Poll until the document is finished processing or the max number of attempts is reached.
The product the RAG database belongs to.
The initial response containing the document's ID.
Options for the polling loop, see PollingOptions.
A Promise containing the RAG document annotation.
ProtectedpollProtected
Polls a job until it is processed or the maximum number of tries is reached.
Search for resources matching the given criteria.
a Promise containing the search response with the matching resources.
Update a document's annotations in the RAG database and poll until ready.
The product the RAG database belongs to.
The parameters to use for the update.
OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
options for the polling loop, see PollingOptions.
a Promise containing the RAG document annotation.
Not recommended for general use, prefer updateAndGetRagAnnotationPoll.
You will need to poll until the document is ready for use.
Update a document's annotations in the RAG database.
Add a document to the RAG database and return the initial annotation.
The product the RAG database belongs to.
The file to upload.
The parameters to use for the upload.
OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
options for the polling loop, see PollingOptions.
Not recommended for general use, prefer uploadAndGetRagDocumentPoll.
You will need to poll until the document is ready for use.
Add a document to the RAG database.
Mindee Client V2 class that centralizes most basic operations.