Interface AiKnowledgeBaseTextContextRequest

Request structure for adding text-based context to an AI agent.

interface AiKnowledgeBaseTextContextRequest {
    contextId: string;
    metadata?: AiContextMetadata;
    options?: AiKnowledgeBaseContextTextOptions;
    text: string;
    title: string;
    type: "text";
}

Hierarchy

BaseAiKnowledgeBaseContextRequest
- AiKnowledgeBaseTextContextRequest

Index

Properties

contextId metadata? options? text title type

Properties

contextId

contextId: string

`Optional`metadata

metadata?: AiContextMetadata

`Optional`options

options?: AiKnowledgeBaseContextTextOptions

General options for how to process the text.

text

text: string

The text content to add to the context.

title

title: string

A title for the text context.

type

type: "text"

Specifies the context type as 'text'.