Class InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface>

Inheritance
object
DescriptorBase<TInferenceProcessorDescriptor, TInferenceProcessorInterface>
ProcessorDescriptorBase<TInferenceProcessorDescriptor, TInferenceProcessorInterface>
InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface>
TextEmbeddingProcessorDescriptor<TDocument>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public abstract class InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface> : ProcessorDescriptorBase<TInferenceProcessorDescriptor, TInferenceProcessorInterface>, IDescriptor, IInferenceProcessor, IProcessor where T : class where TInferenceProcessorDescriptor : InferenceProcessorDescriptorBase<T, TInferenceProcessorDescriptor, TInferenceProcessorInterface>, TInferenceProcessorInterface where TInferenceProcessorInterface : class, IInferenceProcessor
Type Parameters
Name Description
T
TInferenceProcessorDescriptor
TInferenceProcessorInterface

Methods

| Edit this page View Source

FieldMap(IInferenceFieldMap)

Contains key-value pairs that specify the mapping of a text field to a vector field.

  • Key being the name of the field from which to generate embeddings.
  • Value being the name of the vector field in which to store the generated embeddings.
Declaration
public TInferenceProcessorDescriptor FieldMap(IInferenceFieldMap fieldMap)
Parameters
Type Name Description
IInferenceFieldMap fieldMap
Returns
Type Description
TInferenceProcessorDescriptor
| Edit this page View Source

FieldMap(IDictionary<Field, Field>)

Contains key-value pairs that specify the mapping of a text field to a vector field.

  • Key being the name of the field from which to generate embeddings.
  • Value being the name of the vector field in which to store the generated embeddings.
Declaration
public TInferenceProcessorDescriptor FieldMap(IDictionary<Field, Field> fieldMap)
Parameters
Type Name Description
IDictionary<Field, Field> fieldMap
Returns
Type Description
TInferenceProcessorDescriptor
| Edit this page View Source

FieldMap(Func<InferenceFieldMapDescriptor<T>, IPromise<IInferenceFieldMap>>)

Contains key-value pairs that specify the mapping of a text field to a vector field.

  • Key being the name of the field from which to generate embeddings.
  • Value being the name of the vector field in which to store the generated embeddings.
Declaration
public TInferenceProcessorDescriptor FieldMap(Func<InferenceFieldMapDescriptor<T>, IPromise<IInferenceFieldMap>> selector)
Parameters
Type Name Description
Func<InferenceFieldMapDescriptor<T>, IPromise<IInferenceFieldMap>> selector
Returns
Type Description
TInferenceProcessorDescriptor
| Edit this page View Source

FieldMap<TDocument>(Func<InferenceFieldMapDescriptor<TDocument>, IPromise<IInferenceFieldMap>>)

Contains key-value pairs that specify the mapping of a text field to a vector field.

  • Key being the name of the field from which to generate embeddings.
  • Value being the name of the vector field in which to store the generated embeddings.
Declaration
public TInferenceProcessorDescriptor FieldMap<TDocument>(Func<InferenceFieldMapDescriptor<TDocument>, IPromise<IInferenceFieldMap>> selector) where TDocument : class
Parameters
Type Name Description
Func<InferenceFieldMapDescriptor<TDocument>, IPromise<IInferenceFieldMap>> selector
Returns
Type Description
TInferenceProcessorDescriptor
Type Parameters
Name Description
TDocument
| Edit this page View Source

ModelId(string)

The ID of the model that will be used to generate the embeddings. The model must be deployed in OpenSearch before it can be used in neural search.

Declaration
public TInferenceProcessorDescriptor ModelId(string modelId)
Parameters
Type Name Description
string modelId
Returns
Type Description
TInferenceProcessorDescriptor
Remarks

For more information, see Using custom models within OpenSearch and Semantic search.

Implements

Extension Methods