MediaPipeTasksRetrieval Framework Reference

VectorStore

protocol VectorStore : NSObjectProtocol

A protocol that defines the storage backend for semantic retriever.

• delete(withIds:)

  Deletes the records matching the specified IDs.

  Declaration

  Swift

  func delete(withIds ids: [String]) throws

• delete(withMetadataFilter:)

  Deletes records matching the specified metadata filter.

  Declaration

  Swift

  func delete(withMetadataFilter metadataFilter: [String : String]) throws

• deleteAllRecords()

  Deletes all records from the vector store.

  Declaration

  Swift

  func deleteAllRecords() throws

• getRecord(withId:)

  Retrieves a single record matching the specified ID.

  Declaration

  Swift

  func getRecord(withId recordId: String) throws -> RetrievalRecord

• getRecordsWithIds(_:)

  Retrieves the records matching the specified IDs.

  Declaration

  Swift

  func getRecordsWithIds(_ ids: [String]) throws -> [RetrievalRecord]

• recordIdentifiers()

  Retrieves all unique top-level record identifiers in the vector store.

  Declaration

  Swift

  func recordIdentifiers() throws -> [String]

• search(withEmbedding:topK:)

  Searches the top-K nearest records to the query embedding.

  Declaration

  Swift

  func search(withEmbedding queryEmbedding: [NSNumber], topK: Int) throws -> [RetrievalRecord]

• search(withEmbedding:topK:metadataFilter:)

  Searches the top-K nearest records to the query embedding with optional metadata filtering.

  Declaration

  Swift

  func search(withEmbedding queryEmbedding: [NSNumber], topK: Int, metadataFilter: [String : String]?) throws -> [RetrievalRecord]

• upsertRecords(_:)

  Upserts a list of records in the vector store.

  Declaration

  Swift

  func upsertRecords(_ records: [RetrievalRecord]) throws