SongGuess
    Preparing search index...

    Class VectorizeIndexAbstract

    A Vectorize Vector Search Index for querying vectors/embeddings.

    This type is exclusively for the Vectorize beta and will be deprecated once Vectorize RC is released. See Vectorize for its new implementation.

    Index

    Constructors

    Methods

    • Delete a list of vectors with a matching id.

      Parameters

      • ids: string[]

        List of vector ids that should be deleted.

      Returns Promise<VectorizeVectorMutation>

      A promise that resolves with the ids & count of records that were successfully processed (and thus deleted).

    • Get information about the currently bound index.

      Returns Promise<VectorizeIndexDetails>

      A promise that resolves with information about the current index.

    • Get a list of vectors with a matching id.

      Parameters

      • ids: string[]

        List of vector ids that should be returned.

      Returns Promise<VectorizeVector[]>

      A promise that resolves with the raw unscored vectors matching the id set.

    • Insert a list of vectors into the index dataset. If a provided id exists, an error will be thrown.

      Parameters

      Returns Promise<VectorizeVectorMutation>

      A promise that resolves with the ids & count of records that were successfully processed.

    • Use the provided vector to perform a similarity search across the index.

      Parameters

      • vector: number[] | VectorFloatArray

        Input vector that will be used to drive the similarity search.

      • Optionaloptions: VectorizeQueryOptions

        Configuration options to massage the returned data.

      Returns Promise<VectorizeMatches>

      A promise that resolves with matched and scored vectors.

    • Upsert a list of vectors into the index dataset. If a provided id exists, it will be replaced with the new values.

      Parameters

      Returns Promise<VectorizeVectorMutation>

      A promise that resolves with the ids & count of records that were successfully processed.