Class Client

Mindee Client V2 class that centralizes most basic operations.

Constructors

constructor

new Client(options?: ClientOptions): Client
Parameters
- options: ClientOptions = ...
  options for the initialization of a client.
Returns Client
- Defined in src/v2/client.ts:54

Properties

`Protected`mindeeApi

mindeeApi: MindeeApiV2

Mindee V2 API handler.

Methods

deleteRagDocument

deleteRagDocument(
product: P,
documentId: string,
): Promise<boolean>
Deletes a document from the RAG database.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 the product the RAG database belongs to.
- documentId: string
 the document's ID.
Returns Promise<boolean>
- Defined in src/v2/client.ts:406

enqueue

enqueue(
 product: P,
 inputSource: InputSource,
 params:
 | InstanceType<P["parametersClass"]>
 | ConstructorParameters<P["parametersClass"]>[0],
): Promise<JobResponse>
Enqueues a product inference job without waiting for completion.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
- inputSource: InputSource
- params:
 | InstanceType<P["parametersClass"]>
 | ConstructorParameters<P["parametersClass"]>[0]
Returns Promise<JobResponse>
- Defined in src/v2/client.ts:73

enqueueAndGetResult

enqueueAndGetResult(
 product: P,
 inputSource: InputSource,
 params:
 | InstanceType<P["parametersClass"]>
 | ConstructorParameters<P["parametersClass"]>[0],
 pollingOptions?: PollingOptionsConstructor | PollingOptions,
): Promise<InstanceType<P["responseClass"]>>
Enqueue a request and poll the server until the result is sent or until the maximum number of tries is reached.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 the product to retrieve.
- inputSource: InputSource
 file or URL to parse.
- params:
 | InstanceType<P["parametersClass"]>
 | ConstructorParameters<P["parametersClass"]>[0]
 parameters relating to prediction options.
- OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
 options for the polling loop, see PollingOptions.
Returns Promise<InstanceType<P["responseClass"]>>
a Promise containing parsing results.
- Defined in src/v2/client.ts:160

getJob

getJob(jobId: string): Promise<JobResponse>
Get the processing status of a previously enqueued request. Can be used for polling.
Parameters
- jobId: string
 id of the queue to poll.
Returns Promise<JobResponse>
a Promise containing a Job, which also contains a Document if the parsing is complete.
- Defined in src/v2/client.ts:144

getRagDocument

getRagDocument(
product: P,
documentId: string,
): Promise<InstanceType<P["annotationResponseClass"]>>
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.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 the product the RAG database belongs to.
- documentId: string
 the document's ID.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
- Defined in src/v2/client.ts:277

getReadyRagDocumentPoll

getReadyRagDocumentPoll(
 product: P,
 documentId: string,
 pollingOptions?: PollingOptionsConstructor | PollingOptions,
): Promise<InstanceType<P["annotationResponseClass"]>>
Get a document's info and annotations from the RAG database.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 the product the RAG database belongs to.
- documentId: string
 the document's ID.
- OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
 options for the polling loop, see PollingOptions.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
a Promise containing the RAG document annotation.
- Defined in src/v2/client.ts:293

getResult

getResult(
product: P,
inferenceId: string,
): Promise<InstanceType<P["responseClass"]>>
Retrieves the result of a previously enqueued request.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 the product to retrieve.
- inferenceId: string
 id of the queue to poll.
Returns Promise<InstanceType<P["responseClass"]>>
a Promise containing the inference.
- Defined in src/v2/client.ts:106

getResultByUrl

getResultByUrl(
product: P,
url: string,
): Promise<InstanceType<P["responseClass"]>>
Retrieves the result of a previously enqueued request. This method is used when manually polling the server for the result URL.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 the product to retrieve.
- url: string
 URL as given in the getJob() response.
Returns Promise<InstanceType<P["responseClass"]>>
a Promise containing the inference.
- Defined in src/v2/client.ts:125

`Protected`pollForRagDocument

pollForRagDocument(
 product: P,
 initialResponse: InstanceType<P["annotationResponseClass"]>,
 pollingOptions: PollingOptions,
): Promise<InstanceType<P["annotationResponseClass"]>>
Protected
Poll until the document is finished processing or the max number of attempts is reached.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 The product the RAG database belongs to.
- initialResponse: InstanceType<P["annotationResponseClass"]>
 The initial response containing the document's ID.
- pollingOptions: PollingOptions
 Options for the polling loop, see PollingOptions.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
A Promise containing the RAG document annotation.
- Defined in src/v2/client.ts:422

`Protected`pollForResult

pollForResult(
 product: typeof BaseProduct,
 pollingOptions: PollingOptions,
 jobResponse: JobResponse,
): Promise<InstanceType<P["responseClass"]>>
Protected
Send a document to an endpoint and poll the server until the result is sent or until the maximum number of tries is reached.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: typeof BaseProduct
- pollingOptions: PollingOptions
- jobResponse: JobResponse
Returns Promise<InstanceType<P["responseClass"]>>
- Defined in src/v2/client.ts:186

search

search<S extends typeof BaseSearch>(
 search: S,
 searchParameters:
 | InstanceType<S["parametersClass"]>
 | ConstructorParameters<S["parametersClass"]>[0],
): Promise<InstanceType<S["responseClass"]>>
Search for resources matching the given criteria.
Type Parameters
- S extends typeof BaseSearch
Parameters
- search: S
 Search definition class to use.
- searchParameters:
 | InstanceType<S["parametersClass"]>
 | ConstructorParameters<S["parametersClass"]>[0]
 Search parameters.
Returns Promise<InstanceType<S["responseClass"]>>
a Promise containing the search response with the matching resources.
- Defined in src/v2/client.ts:256

searchModels

searchModels(name?: string, modelType?: string): Promise<SearchResponse>
Search for models available to the account.
Parameters
- Optionalname: string
 Optional name filter.
- OptionalmodelType: string
 Optional model type filter.
Returns Promise<SearchResponse>
a Promise containing the search response.

Deprecated
Use search(ModelSearch, {}) instead.
- Defined in src/v2/client.ts:246

updateAndGetRagAnnotationPoll

updateAndGetRagAnnotationPoll(
 product: P,
 parameters:
 | InstanceType<P["annotationParametersClass"]>
 | ConstructorParameters<P["annotationParametersClass"]>[0],
 pollingOptions?: PollingOptionsConstructor | PollingOptions,
): Promise<InstanceType<P["annotationResponseClass"]>>
Update a document's annotations in the RAG database and poll until ready.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 The product the RAG database belongs to.
- parameters:
 | InstanceType<P["annotationParametersClass"]>
 | ConstructorParameters<P["annotationParametersClass"]>[0]
 The parameters to use for the update.
- OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
 options for the polling loop, see PollingOptions.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
a Promise containing the RAG document annotation.
- Defined in src/v2/client.ts:384

updateRagAnnotation

updateRagAnnotation(
 product: P,
 parameters:
 | InstanceType<P["annotationParametersClass"]>
 | ConstructorParameters<P["annotationParametersClass"]>[0],
): Promise<InstanceType<P["annotationResponseClass"]>>
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.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 The product the RAG database belongs to.
- parameters:
 | InstanceType<P["annotationParametersClass"]>
 | ConstructorParameters<P["annotationParametersClass"]>[0]
 The parameters to use for the update.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
- Defined in src/v2/client.ts:363

uploadAndGetRagDocumentPoll

uploadAndGetRagDocumentPoll(
 product: P,
 inputSource: LocalInputSource,
 parameters:
 | InstanceType<P["ragDocumentUploadClass"]>
 | ConstructorParameters<P["ragDocumentUploadClass"]>[0],
 pollingOptions?: PollingOptionsConstructor | PollingOptions,
): Promise<InstanceType<P["annotationResponseClass"]>>
Add a document to the RAG database and return the initial annotation.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 The product the RAG database belongs to.
- inputSource: LocalInputSource
 The file to upload.
- parameters:
 | InstanceType<P["ragDocumentUploadClass"]>
 | ConstructorParameters<P["ragDocumentUploadClass"]>[0]
 The parameters to use for the upload.
- OptionalpollingOptions: PollingOptionsConstructor | PollingOptions
 options for the polling loop, see PollingOptions.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
- Defined in src/v2/client.ts:338

uploadRagDocument

uploadRagDocument(
 product: P,
 inputSource: LocalInputSource,
 parameters:
 | InstanceType<P["ragDocumentUploadClass"]>
 | ConstructorParameters<P["ragDocumentUploadClass"]>[0],
): Promise<InstanceType<P["annotationResponseClass"]>>
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.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
 The product the RAG database belongs to.
- inputSource: LocalInputSource
 The file to upload.
- parameters:
 | InstanceType<P["ragDocumentUploadClass"]>
 | ConstructorParameters<P["ragDocumentUploadClass"]>[0]
 The parameters to use for the upload.
Returns Promise<InstanceType<P["annotationResponseClass"]>>
- Defined in src/v2/client.ts:317

Class Client

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Client

Properties

ProtectedmindeeApi

Methods

deleteRagDocument

Type Parameters

Parameters

Returns Promise<boolean>

enqueue

Type Parameters

Parameters

Returns Promise<JobResponse>

enqueueAndGetResult

Type Parameters

Parameters

Returns Promise<InstanceType<P["responseClass"]>>

getJob

Parameters

Returns Promise<JobResponse>

getRagDocument

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

getReadyRagDocumentPoll

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

getResult

Type Parameters

Parameters

Returns Promise<InstanceType<P["responseClass"]>>

getResultByUrl

Type Parameters

Parameters

Returns Promise<InstanceType<P["responseClass"]>>

ProtectedpollForRagDocument

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

ProtectedpollForResult

Type Parameters

Parameters

Returns Promise<InstanceType<P["responseClass"]>>

search

Type Parameters

Parameters

Returns Promise<InstanceType<S["responseClass"]>>

searchModels

Parameters

Returns Promise<SearchResponse>

Deprecated

updateAndGetRagAnnotationPoll

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

updateRagAnnotation

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

uploadAndGetRagDocumentPoll

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

uploadRagDocument

Type Parameters

Parameters

Returns Promise<InstanceType<P["annotationResponseClass"]>>

Settings

On This Page

`Protected`mindeeApi

`Protected`pollForRagDocument

`Protected`pollForResult