boldare-openai-assistant

Namespace

boldare-openai-assistant

Description:

  • Transform your NestJS application with our AI Assistant library, offering fast setup and seamless integration with OpenAI for dynamic conversational experiences. Develop efficient chatbots in minutes!

Author:
Copyright:
  • 2025 Eyevinn Technology AB

Methods

(async, static) createBoldareOpenaiAssistantInstance(context, body) → {BoldareOpenaiAssistant}

Description:

  • Create a new OpenAI Assistant instance

Example
import { Context } from '@osaas/client-core';
import { createBoldareOpenaiAssistantInstance } from '@osaas/client-services';

const ctx = new Context();
const body: BoldareOpenaiAssistantConfig = { name: 'myinstance', ... };
const instance = await createBoldareOpenaiAssistantInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body BoldareOpenaiAssistantConfig

Service instance configuration
Returns:
  • Service instance
Type
BoldareOpenaiAssistant

(async, static) getBoldareOpenaiAssistantInstance(context, name) → {BoldareOpenaiAssistant}

Description:

  • Get a OpenAI Assistant instance

Example
import { Context } from '@osaas/client-core';
import { getBoldareOpenaiAssistantInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getBoldareOpenaiAssistantInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the assistant to be retrieved
Returns:
  • Service instance
Type
BoldareOpenaiAssistant

(async, static) removeBoldareOpenaiAssistantInstance(context, name)

Description:

  • Remove a OpenAI Assistant instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the assistant to be removed