Type Alias Assistant

type Assistant = {
    createdAt: string;
    createdBy: string;
    customProperties: unknown;
    defaultPromptType?: "thread" | "oneshot";
    description: string;
    hasAvatar?: boolean;
    id: string;
    knowledgeBases: string[];
    name: string;
    orderedStarterIds?: string[];
    ownerId: string;
    spaceId: string;
    systemMessage?: string;
    tags: string[];
    tenantId: string;
    title?: string;
    updatedAt: string;
    updatedBy: string;
    welcomeMessage: string;
}
Index

Properties

createdAt createdBy customProperties defaultPromptType? description hasAvatar? id knowledgeBases name orderedStarterIds? ownerId spaceId systemMessage? tags tenantId title? updatedAt updatedBy welcomeMessage

Properties

createdAt: string

Datetime when the assistant was created.

createdBy: string

Unique identifier of the user who created the assistant.

customProperties: unknown

freeform JSON to allow custom customization options.

defaultPromptType?: "thread" | "oneshot"

Default prompt type for the assistant.

description: string

The description of the assistant.

hasAvatar?: boolean

Indicates if the assistant has an avatar.

id: string

Unique identifier of the assistant.

knowledgeBases: string[]

List of knowledgebases the assistant is using.

name: string

The name of the assistant.

orderedStarterIds?: string[]

List of starter IDs in the order they will be sorted.

ownerId: string

Unique identifier of the assistant owner.

spaceId: string

Unique identifier of the space containing the assistant.

systemMessage?: string

System prompt setting up conversation context.

tags: string[]

The list of tags associated with the assistant.

tenantId: string

Unique identifier of the assistant tenant.

title?: string

The title of the assistant.

updatedAt: string

Datetime when the assistant was updated.

updatedBy: string

Unique identifier of the user who last updated the assistant.

welcomeMessage: string

Initial message in the chat conversation.

Settings

Member Visibility

On This Page

Properties