PipelineDefinitionBuilderVectorSearchTInput, TOutput Method (PipelineDefinitionTInput, TOutput, FieldDefinitionTOutput, QueryVector, Int32, VectorSearchOptionsTOutput) |
Appends a $vectorSearch stage to the pipeline.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax public static PipelineDefinition<TInput, TOutput> VectorSearch<TInput, TOutput>(
this PipelineDefinition<TInput, TOutput> pipeline,
FieldDefinition<TOutput> field,
QueryVector queryVector,
int limit,
VectorSearchOptions<TOutput> options = null
)
<ExtensionAttribute>
Public Shared Function VectorSearch(Of TInput, TOutput) (
pipeline As PipelineDefinition(Of TInput, TOutput),
field As FieldDefinition(Of TOutput),
queryVector As QueryVector,
limit As Integer,
Optional options As VectorSearchOptions(Of TOutput) = Nothing
) As PipelineDefinition(Of TInput, TOutput)
[<ExtensionAttribute>]
static member VectorSearch :
pipeline : PipelineDefinition<'TInput, 'TOutput> *
field : FieldDefinition<'TOutput> *
queryVector : QueryVector *
limit : int *
?options : VectorSearchOptions<'TOutput>
(* Defaults:
let _options = defaultArg options null
*)
-> PipelineDefinition<'TInput, 'TOutput>
Parameters
- pipeline
- Type: MongoDB.DriverPipelineDefinitionTInput, TOutput
The pipeline. - field
- Type: MongoDB.DriverFieldDefinitionTOutput
The field. - queryVector
- Type: MongoDB.DriverQueryVector
The query vector. - limit
- Type: SystemInt32
The limit. - options (Optional)
- Type: MongoDB.DriverVectorSearchOptionsTOutput
The vector search options.
Type Parameters
- TInput
- The type of the input.
- TOutput
- The type of the output.
Return Value
Type:
PipelineDefinitionTInput,
TOutputA new pipeline with an additional stage.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
PipelineDefinitionTInput,
TOutput. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also