SongGuess
    Preparing search index...

    Class AiSearchInstanceAbstract

    Instance-level AI Search service.

    Used as:

    • The return type of AiSearchNamespace.get(name) (namespace binding)
    • The type of env.BLOG_SEARCH (single instance binding via ai_search)

    Provides search, chat, update, stats, items, and jobs operations.

    // Via namespace binding
    const instance = env.AI_SEARCH.get("blog");
    const results = await instance.search({
      query: "How does caching work?",
    });

    // Via single instance binding
    const results = await env.BLOG_SEARCH.search({
      messages: [{ role: "user", content: "How does caching work?" }],
    });
    Index

    Constructors

    constructor

    Accessors

    items jobs

    Methods

    chatCompletions info search stats update

    Constructors

    Accessors

    • get items(): AiSearchItems

      Items collection — list, upload, and manage items in this instance.

      Returns AiSearchItems

    • get jobs(): AiSearchJobs

      Jobs collection — list, create, and inspect indexing jobs.

      Returns AiSearchJobs

    Methods

    • Get instance statistics (item count, indexing status, etc.).

      Returns Promise<AiSearchStatsResponse>

      Statistics with counts per status, last activity time, and engine details.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods