Class AiFunctionsClient

Index

Constructors

Methods

aiClassify aiDecide aiExtract aiParseDocument cancelBatch createBatch getBatch listBatches listBatchesIter

Constructors

constructor

new AiFunctionsClient(options: ClientOptions): AiFunctionsClient
Parameters
- options: ClientOptions
Returns AiFunctionsClient
- Defined in client.ts:70

Methods

aiClassify

aiClassify(
req: AiClassifyRequest,
options?: CallOptions,
): Promise<AiClassifyResponse>
Classifies content according to a set of provided labels. For REST API requests, the default rate limit is 1,200 requests per minute per workspace. Contact your account team to request a higher limit.
Parameters
- req: AiClassifyRequest
- Optionaloptions: CallOptions
Returns Promise<AiClassifyResponse>
- Defined in client.ts:227

aiDecide

aiDecide(req: AiDecideRequest, options?: CallOptions): Promise<AiDecideResponse>
Turn text and structured data into decisions your application can use. Define questions and criteria to choose an option, estimate a probability, or assign a score given a provided state.
Parameters
- req: AiDecideRequest
- Optionaloptions: CallOptions
Returns Promise<AiDecideResponse>
- Defined in client.ts:257

aiExtract

aiExtract(
req: AiExtractRequest,
options?: CallOptions,
): Promise<AiExtractResponse>
Extracts structured data from text and documents according to a provided schema. For REST API requests, the default rate limit is 120 requests per minute per workspace. Contact your account team to request a higher limit.
Parameters
- req: AiExtractRequest
- Optionaloptions: CallOptions
Returns Promise<AiExtractResponse>
- Defined in client.ts:287

aiParseDocument

aiParseDocument(
req: AiParseDocumentRequest,
options?: CallOptions,
): Promise<AiParseDocumentResponse>
Parse structured content from unstructured documents.
Parameters
- req: AiParseDocumentRequest
- Optionaloptions: CallOptions
Returns Promise<AiParseDocumentResponse>
- Defined in client.ts:317

cancelBatch

cancelBatch(
req: CancelBatchRequest,
options?: CallOptions,
): Promise<CancelBatchResponse>
Cancel a batch. Cancellation is asynchronous: requests in flight drain first, so read the batch to observe the CANCELLING and CANCELLED statuses.
Parameters
- req: CancelBatchRequest
- Optionaloptions: CallOptions
Returns Promise<CancelBatchResponse>
- Defined in client.ts:86

createBatch

createBatch(req: CreateBatchRequest, options?: CallOptions): Promise<Batch>
Run an AI function over every request in a file on a Unity Catalog volume. The batch runs asynchronously; read it to follow its progress.
Parameters
- req: CreateBatchRequest
- Optionaloptions: CallOptions
Returns Promise<Batch>
- Defined in client.ts:116

getBatch

getBatch(req: GetBatchRequest, options?: CallOptions): Promise<Batch>
Read one batch, with its status and progress.
Parameters
- req: GetBatchRequest
- Optionaloptions: CallOptions
Returns Promise<Batch>
- Defined in client.ts:146

listBatches

listBatches(
req: ListBatchesRequest,
options?: CallOptions,
): Promise<ListBatchesResponse>
List the batches the caller created in this workspace.
Parameters
- req: ListBatchesRequest
- Optionaloptions: CallOptions
Returns Promise<ListBatchesResponse>
- Defined in client.ts:172

listBatchesIter

listBatchesIter(
req: ListBatchesRequest,
options?: CallOptions,
): AsyncGenerator<Batch>
Parameters
- req: ListBatchesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Batch>
- Defined in client.ts:209