Class Milvus

Class for interacting with a Milvus database. Extends the VectorStore class.

Hierarchy

VectorStore
- Milvus

Constructors

constructor

new Milvus(embeddings, args): Milvus
Parameters
- embeddings: Embeddings
- args: MilvusLibArgs
Returns Milvus
Overrides VectorStore.constructor
- Defined in langchain/src/vectorstores/milvus.ts:121

Properties

FilterType

FilterType: string

client

client: MilvusClient

collectionName

collectionName: string

embeddings

embeddings: Embeddings

fields

fields: string[]

indexCreateParams

indexCreateParams: {
    index_type: string;
    metric_type: string;
    params: string;
} = ...

Type declaration

index_type: string
metric_type: string
params: string

indexParams

indexParams: Record<IndexType, IndexParam> = ...

indexSearchParams

indexSearchParams: string = ...

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

primaryField

primaryField: string

textField

textField: string

textFieldMaxLength

textFieldMaxLength: number

vectorField

vectorField: string

`Optional` autoId

autoId?: boolean

`Optional` numDimensions

numDimensions?: number

Accessors

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from VectorStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from VectorStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from VectorStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns {
[key: string]: string;
}
- [key: string]: string
Overrides VectorStore.lc_secrets
- Defined in langchain/src/vectorstores/milvus.ts:69

Methods

_vectorstoreType

_vectorstoreType(): string
Returns string
Overrides VectorStore._vectorstoreType
- Defined in langchain/src/vectorstores/milvus.ts:117

addDocuments

addDocuments(documents): Promise<void>
Adds documents to the Milvus database.
Parameters
- documents: Document<Record<string, any>>[]
  
  Array of Document instances to be added to the database.
Returns Promise<void>
Promise resolving to void.
Overrides VectorStore.addDocuments
- Defined in langchain/src/vectorstores/milvus.ts:163

addVectors

addVectors(vectors, documents): 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.
Returns Promise<void>
Promise resolving to void.
Overrides VectorStore.addVectors
- Defined in langchain/src/vectorstores/milvus.ts:177

asRetriever

asRetriever(kOrFields?, filter?, callbacks?, tags?, metadata?, verbose?): VectorStoreRetriever<Milvus>
Parameters
- Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Milvus>>
- Optional filter: string
- Optional callbacks: Callbacks
- Optional tags: string[]
- Optional metadata: Record<string, unknown>
- Optional verbose: boolean
Returns VectorStoreRetriever<Milvus>
Inherited from VectorStore.asRetriever
- Defined in langchain/src/vectorstores/base.ts:246

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.
- Defined in langchain/src/vectorstores/milvus.ts:353

delete

delete(params): Promise<void>
Deletes data from the Milvus database.
Parameters
- params: {
  filter: string;
  }
  
  Object containing a filter to apply to the deletion.
  - filter: string
Returns Promise<void>
Promise resolving to void.
Overrides VectorStore.delete
- Defined in langchain/src/vectorstores/milvus.ts:531

ensureCollection

ensureCollection(vectors?, documents?): Promise<void>
Ensures that a collection exists in the Milvus database.
Parameters
- Optional vectors: number[][]
  
  Optional array of vectors to be used if a new collection needs to be created.
- Optional documents: 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.
- Defined in langchain/src/vectorstores/milvus.ts:325

grabCollectionFields

grabCollectionFields(): Promise<void>
Retrieves the fields of a collection in the Milvus database.

Returns Promise<void>
Promise resolving to void.
- Defined in langchain/src/vectorstores/milvus.ts:417

similaritySearch

similaritySearch(query, k?, filter?, _callbacks?): Promise<Document<Record<string, any>>[]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<Document<Record<string, any>>[]>
Inherited from VectorStore.similaritySearch
- Defined in langchain/src/vectorstores/base.ts:174

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.
- Optional filter: 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.
Overrides VectorStore.similaritySearchVectorWithScore
- Defined in langchain/src/vectorstores/milvus.ts:245

similaritySearchWithScore

similaritySearchWithScore(query, k?, filter?, _callbacks?): Promise<[Document<Record<string, any>>, number][]>
Parameters
- query: string
- k: number = 4
- filter: undefined | string = undefined
- _callbacks: undefined | Callbacks = undefined
Returns Promise<[Document<Record<string, any>>, number][]>
Inherited from VectorStore.similaritySearchWithScore
- Defined in langchain/src/vectorstores/base.ts:189

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from VectorStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from VectorStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`Optional` maxMarginalRelevanceSearch

maxMarginalRelevanceSearch(query, options, _callbacks): Promise<Document<Record<string, any>>[]>
Return documents selected using the maximal marginal relevance. Maximal marginal relevance optimizes for similarity to the query AND diversity among selected documents.
Parameters
- query: string
  
  Text to look up documents similar to.
- options: MaxMarginalRelevanceSearchOptions<string>
- _callbacks: undefined | Callbacks
Returns Promise<Document<Record<string, any>>[]>
- List of documents selected by maximal marginal relevance.
Inherited from VectorStore.maxMarginalRelevanceSearch
- Defined in langchain/src/vectorstores/base.ts:217

`Static` fromDocuments

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: Embeddings
  
  Embeddings instance used to generate vector embeddings for the documents.
- Optional dbConfig: MilvusLibArgs
  
  Optional configuration for the Milvus database.
Returns Promise<Milvus>
Promise resolving to a new Milvus instance.
Overrides VectorStore.fromDocuments
- Defined in langchain/src/vectorstores/milvus.ts:488

`Static` fromExistingCollection

fromExistingCollection(embeddings, dbConfig): Promise<Milvus>
Creates a Milvus instance from an existing collection in the Milvus database.
Parameters
- embeddings: Embeddings
  
  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.
- Defined in langchain/src/vectorstores/milvus.ts:517

`Static` fromTexts

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: Embeddings
  
  Embeddings instance used to generate vector embeddings for the texts.
- Optional dbConfig: MilvusLibArgs
  
  Optional configuration for the Milvus database.
Returns Promise<Milvus>
Promise resolving to a new Milvus instance.
Overrides VectorStore.fromTexts
- Defined in langchain/src/vectorstores/milvus.ts:463

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from VectorStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class Milvus

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

embeddings: Embeddings

args: MilvusLibArgs

Returns Milvus

Properties

FilterType

client

collectionName

embeddings

fields

indexCreateParams

Type declaration

index_type: string

metric_type: string

params: string

indexParams

indexSearchParams

lc_kwargs

lc_namespace

lc_serializable

primaryField

textField

textFieldMaxLength

vectorField

Optional autoId

Optional numDimensions

Accessors

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns { [key: string]: string; }

[key: string]: string

Methods

_vectorstoreType

Returns string

addDocuments

Parameters

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

Returns Promise<void>

addVectors

Parameters

vectors: number[][]

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

Returns Promise<void>

asRetriever

Parameters

Optional kOrFields: number | Partial<VectorStoreRetrieverInput<Milvus>>

Optional filter: string

Optional callbacks: Callbacks

Optional tags: string[]

Optional metadata: Record<string, unknown>

Optional verbose: boolean

Returns VectorStoreRetriever<Milvus>

createCollection

Parameters

vectors: number[][]

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

Returns Promise<void>

delete

Parameters

params: { filter: string; }

filter: string

Returns Promise<void>

ensureCollection

Parameters

Optional vectors: number[][]

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

`Optional` autoId

`Optional` numDimensions

Returns undefined | {
[key: string]: string;
}

Returns {
[key: string]: string;
}

`Optional` kOrFields: number | Partial<VectorStoreRetrieverInput<Milvus>>

`Optional` filter: string

`Optional` callbacks: Callbacks

`Optional` tags: string[]

`Optional` metadata: Record<string, unknown>

`Optional` verbose: boolean

params: {
filter: string;
}

`Optional` vectors: number[][]

`Optional` documents: Document<Record<string, any>>[]

`Optional` filter: string

`Optional` maxMarginalRelevanceSearch

`Static` fromDocuments

`Optional` dbConfig: MilvusLibArgs

`Static` fromExistingCollection

`Static` fromTexts

`Optional` dbConfig: MilvusLibArgs

`Static` lc_name