Type Alias CreateAssistant

type CreateAssistant = {
    customProperties: unknown;
    defaultPromptType?: "thread" | "oneshot";
    description: string;
    knowledgeBases: string[];
    name: string;
    orderedStarterIds?: string[];
    spaceId: string;
    systemMessage?: string;
    tags: string[];
    title: string;
    welcomeMessage: string;
}
Index

Properties

customProperties defaultPromptType? description knowledgeBases name orderedStarterIds? spaceId systemMessage? tags title welcomeMessage

Properties

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.

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.

spaceId: string

Unique identifier of the space to contain the assistant.

systemMessage?: string

System prompt setting up conversation context.

tags: string[]

The list of tags for the assistant.

title: string

The title of the assistant.

welcomeMessage: string

Initial message in the chat conversation.

Settings

Member Visibility

On This Page

Properties