Class MatchingEngine

constructor

• new MatchingEngine(embeddings, args): MatchingEngine

• Parameters

  • embeddings: Embeddings

  • args: MatchingEngineArgs

  Returns MatchingEngine

FilterType

apiEndpoint

apiVersion

authOptions

caller

callerOptions

callerParams

deployedIndexId

docstore

endpoint

index

indexEndpoint

indexEndpointClient

location

removeDatapointClient

upsertDatapointClient

addDocuments

• addDocuments(documents): Promise<void>

• Parameters

  • documents: Document<Record<string, any>>[]

  Returns Promise<void>

addVectors

• addVectors(vectors, documents): Promise<void>

• Parameters

  • vectors: number[][]

  • documents: Document<Record<string, any>>[]

  Returns Promise<void>

buildDatapoint

• buildDatapoint(vector, document): IndexDatapoint

• Create an index datapoint for the vector and document id. If an id does not exist, create it and set the document to its value.

  Parameters

  • vector: number[]

  • document: IdDocument

  Returns IndexDatapoint

cleanMetadata

• cleanMetadata(documentMetadata): {
      [key: string]: string | number | boolean | string[] | null;
  }

• Parameters

  • documentMetadata: Record<string, any>

  Returns {
      [key: string]: string | number | boolean | string[] | null;
  }

  • [key: string]: string | number | boolean | string[] | null

delete

• delete(params): Promise<void>

• Parameters

  • params: MatchingEngineDeleteParams

  Returns Promise<void>

determinePublicAPIEndpoint

• determinePublicAPIEndpoint(): Promise<PublicAPIEndpointInfo>

• For this index endpoint, figure out what API Endpoint URL and deployed index ID should be used to do upserts and queries. Also sets the apiEndpoint and deployedIndexId property for future use.

  Returns Promise<PublicAPIEndpointInfo>

  The URL

getDeployedIndexId

• getDeployedIndexId(): Promise<string>

• Returns Promise<string>

getPublicAPIEndpoint

• getPublicAPIEndpoint(): Promise<string>

• Returns Promise<string>

metadataToRestrictions

• metadataToRestrictions(documentMetadata): Restriction[]

• Given the metadata from a document, convert it to an array of Restriction objects that may be passed to the Matching Engine and stored. The default implementation flattens any metadata and includes it as an "allowList". Subclasses can choose to convert some of these to "denyList" items or to add additional restrictions (for example, to format dates into a different structure or to add additional restrictions based on the date).

  Parameters

  • documentMetadata: Record<string, any>

    The metadata from a document

  Returns Restriction[]

  a Restriction[] (or an array of a subclass, from the FilterType)

similaritySearchVectorWithScore

• similaritySearchVectorWithScore(query, k, filter?): Promise<[Document<Record<string, any>>, number][]>

• Parameters

  • query: number[]

  • k: number

  • Optional filter: Restriction[]

  Returns Promise<[Document<Record<string, any>>, number][]>

Static fromDocuments

• fromDocuments(docs, embeddings, dbConfig): Promise<VectorStore>

• Parameters

  • docs: Document<Record<string, any>>[]

  • embeddings: Embeddings

  • dbConfig: MatchingEngineArgs

  Returns Promise<VectorStore>

Static fromTexts

• fromTexts(texts, metadatas, embeddings, dbConfig): Promise<VectorStore>

• Parameters

  • texts: string[]

  • metadatas: object | object[]

  • embeddings: Embeddings

  • dbConfig: MatchingEngineArgs

  Returns Promise<VectorStore>