Class Milvus

constructor

• new Milvus(embeddings, args): Milvus

• Parameters

  • embeddings: EmbeddingsInterface
  • args: MilvusLibArgs

  Returns Milvus

FilterType

OptionalautoId

client

collectionName

fields

indexCreateParams

indexSearchParams

OptionalnumDimensions

OptionalpartitionKey

OptionalpartitionKeyMaxLength

OptionalpartitionName

primaryField

textField

textFieldMaxLength

vectorField

addDocuments

• addDocuments(documents, options?): Promise<void>

• Adds documents to the Milvus database.

  Parameters

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

    Array of Document instances to be added to the database.
  • Optionaloptions: {
        ids?: string[];
    }

    Optional parameter that can include specific IDs for the documents.

    • Optionalids?: string[]

  Returns Promise<void>

  Promise resolving to void.

addVectors

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

• Adds vectors to the Milvus database.

  Parameters

  • vectors: number[][]

    Array of vectors to be added to the database.
  • documents: Document<Record<string, any>>[]

    Array of Document instances associated with the vectors.
  • Optionaloptions: {
        ids?: string[];
    }

    Optional parameter that can include specific IDs for the documents.

    • Optionalids?: string[]

  Returns Promise<void>

  Promise resolving to void.

createCollection

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

• Creates a collection in the Milvus database.

  Parameters

  • vectors: number[][]

    Array of vectors to be added to the new collection.
  • documents: Document<Record<string, any>>[]

    Array of Document instances to be added to the new collection.

  Returns Promise<void>

  Promise resolving to void.

delete

• delete(params): Promise<void>

• Deletes data from the Milvus database.

  Parameters

  • params: {
        filter?: string;
        ids?: string[];
    }

    Object containing a filter to apply to the deletion.

    • Optionalfilter?: string

    • Optionalids?: string[]

  Returns Promise<void>

  Promise resolving to void.

ensureCollection

• ensureCollection(vectors?, documents?): Promise<void>

• Ensures that a collection exists in the Milvus database.

  Parameters

  • Optionalvectors: number[][]

    Optional array of vectors to be used if a new collection needs to be created.
  • Optionaldocuments: Document<Record<string, any>>[]

    Optional array of Document instances to be used if a new collection needs to be created.

  Returns Promise<void>

  Promise resolving to void.

ensurePartition

• ensurePartition(): Promise<void>

• Ensures that a partition exists in the Milvus collection.

  Returns Promise<void>

  Promise resolving to void.

grabCollectionFields

• grabCollectionFields(): Promise<void>

• Retrieves the fields of a collection in the Milvus database.

  Returns Promise<void>

  Promise resolving to void.

similaritySearchVectorWithScore

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

• Searches for vectors in the Milvus database that are similar to a given vector.

  Parameters

  • query: number[]

    Vector to compare with the vectors in the database.
  • k: number

    Number of similar vectors to return.
  • Optionalfilter: string

    Optional filter to apply to the search.

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

  Promise resolving to an array of tuples, each containing a Document instance and a similarity score.

StaticfromDocuments

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

• Creates a Milvus instance from a set of Document instances.

  Parameters

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

    Array of Document instances to be added to the database.
  • embeddings: EmbeddingsInterface

    Embeddings instance used to generate vector embeddings for the documents.
  • OptionaldbConfig: MilvusLibArgs

    Optional configuration for the Milvus database.

  Returns Promise<Milvus>

  Promise resolving to a new Milvus instance.

StaticfromExistingCollection

• fromExistingCollection(embeddings, dbConfig): Promise<Milvus>

• Creates a Milvus instance from an existing collection in the Milvus database.

  Parameters

  • embeddings: EmbeddingsInterface

    Embeddings instance used to generate vector embeddings for the documents in the collection.
  • dbConfig: MilvusLibArgs

    Configuration for the Milvus database.

  Returns Promise<Milvus>

  Promise resolving to a new Milvus instance.

StaticfromTexts

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

• Creates a Milvus instance from a set of texts and their associated metadata.

  Parameters

  • texts: string[]

    Array of texts to be added to the database.
  • metadatas: object | object[]

    Array of metadata objects associated with the texts.
  • embeddings: EmbeddingsInterface

    Embeddings instance used to generate vector embeddings for the texts.
  • OptionaldbConfig: MilvusLibArgs

    Optional configuration for the Milvus database.

  Returns Promise<Milvus>

  Promise resolving to a new Milvus instance.