Class InferenceProcessorBase

Inheritance

object

ProcessorBase

InferenceProcessorBase

TextEmbeddingProcessor

Implements

IInferenceProcessor

IProcessor

Inherited Members

ProcessorBase.If

ProcessorBase.Tag

ProcessorBase.IgnoreFailure

ProcessorBase.OnFailure

ProcessorBase.Name

ProcessorBase.Description

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public abstract class InferenceProcessorBase : ProcessorBase, IInferenceProcessor, IProcessor

Properties

FieldMap

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 IInferenceFieldMap FieldMap { get; set; }

Property Value

Type	Description
IInferenceFieldMap

ModelId

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 string ModelId { get; set; }

Property Value

Type	Description
string

Remarks

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

Implements

IInferenceProcessor

IProcessor

Extension Methods

SuffixExtensions.Suffix(object, string)