Module org.elasticsearch.server
Package org.elasticsearch.inference

Interface ServiceSettings

All Superinterfaces:
FilteredXContent, NamedWriteable, ToXContent, ToXContentObject, VersionedNamedWriteable, Writeable
public interface ServiceSettings extends ToXContentObject, VersionedNamedWriteable, FilteredXContent

  • Method Details

    • similarity

      default SimilarityMeasure similarity()
      Similarity used in the service. Will be null if not applicable.
      Returns:
      similarity

    • dimensions

      default Integer dimensions()
      Number of dimensions the service works with. Will be null if not applicable.
      Returns:
      number of dimensions

    • dimensionsSetByUser

      default Boolean dimensionsSetByUser()
      Boolean signifying whether the dimensions were set by the user
      Returns:
      boolean signifying whether the dimensions were set by the user

    • elementType

      default DenseVectorFieldMapper.ElementType elementType()
      The data type for the embeddings this service works with. Defaults to null, Text Embedding models should return a non-null value
      Returns:
      the element type

    • modelId

      @Nullable String modelId()
      The model to use in the inference endpoint (e.g. text-embedding-ada-002). Sometimes the model is not defined in the service settings. This can happen for external providers (e.g. hugging face, azure ai studio) where the provider requires that the model be chosen when initializing a deployment within their service. In this situation, return null.
      Returns:
      the model used to perform inference or null if the model is not defined