Skip to content

VectorStoreSearchResults

A page of search results from the vector store.

Example Usage

typescript
import { VectorStoreSearchResults } from "@meetkai/mka1/models/components";

let value: VectorStoreSearchResults = {
  object: "vector_store.search_results.page",
  searchQuery: "How do I reset my password?",
  data: [
    {
      fileId: "file-abc123",
      filename: "user-guide.pdf",
      score: 0.92,
      content: [
        {
          type: "text",
          text:
            "To reset your password, navigate to Settings > Security > Reset Password...",
        },
      ],
    },
  ],
  hasMore: false,
  nextPage: null,
};

Fields

FieldTypeRequiredDescription
object"vector_store.search_results.page"✔️The object type, which is always 'vector_store.search_results.page'.
searchQuerystring✔️The query that was used for the search.
datacomponents.VectorSearchResult[]✔️Array of search results.
hasMoreboolean✔️Whether there are more results available.
nextPagestring✔️Cursor for the next page of results, or null if no more results.