Interface IGenerativeAIContext

Represents a context for a Generative AI service.

interface IGenerativeAIContext {
    close(): void;
    createAIJob(parameters: IGenerativeAIPromptCreateJobParameters): IGenerativeAIPromptJob;
    createAIJob(parameters: IGenerativeAIRatingCreateJobParameters): IGenerativeAIRatingJob;
    createAIJob(parameters: IGenerativeAIDownloadDocumentCreateJobParameters): IGenerativeAIDownloadDocumentJob;
    downloadDocument(documentPath: string): Promise<IGenerativeAIDownloadDocumentResult>;
    getDataBucketIds(): Promise<string[]>;
    ratePrompt(parameters: IGenerativeAIRatingCreateJobParameters): Promise<IGenerativeAIRatingResult>;
}

Index

Methods

close createAIJob downloadDocument getDataBucketIds ratePrompt

Methods

close

close(): void
Close the Generative AI Context.

Returns void

createAIJob

createAIJob(parameters): IGenerativeAIPromptJob
Create an AI job. The job is bounded to the context.
Parameters
- parameters: IGenerativeAIPromptCreateJobParameters
  The parameters of the AI job.
Returns IGenerativeAIPromptJob
The job ready to be run or streamed.
createAIJob(parameters): IGenerativeAIRatingJob
Parameters
- parameters: IGenerativeAIRatingCreateJobParameters
Returns IGenerativeAIRatingJob
createAIJob(parameters): IGenerativeAIDownloadDocumentJob
Parameters
- parameters: IGenerativeAIDownloadDocumentCreateJobParameters
Returns IGenerativeAIDownloadDocumentJob

downloadDocument

downloadDocument(documentPath): Promise<IGenerativeAIDownloadDocumentResult>
Download a document.
Parameters
- documentPath: string
  The path of the document to download.
Returns Promise<IGenerativeAIDownloadDocumentResult>
A promise that resolves with the result containing the document as an ArrayBuffer.

getDataBucketIds

getDataBucketIds(): Promise<string[]>
Get the data bucket IDs.

Returns Promise<string[]>
An array of data bucket IDs.

ratePrompt

ratePrompt(parameters): Promise<IGenerativeAIRatingResult>
Rate a prompt.
Parameters
- parameters: IGenerativeAIRatingCreateJobParameters
  The parameters of the rating job.
Returns Promise<IGenerativeAIRatingResult>
A promise that resolves with the result.