/* SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. * * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ using System.Collections.Generic; using System.Runtime.Serialization; using OpenSearch.Net.Utf8Json; namespace OpenSearch.Client { /// /// Normalizers are similar to analyzers except that they may only emit a single token. /// As a consequence, they do not have a tokenizer and only accept a subset of the available /// char filters and token filters. Only the filters that work on a per-character basis are /// allowed. For instance a lowercasing filter would be allowed, but not a stemming filter, /// which needs to look at the keyword as a whole. /// OpenSearch does not ship with built-in normalizers so far, so the only way to create one is through composing a custom one /// [InterfaceDataContract] public interface ICustomNormalizer : INormalizer { /// /// Char filters to normalize the keyword /// [DataMember(Name ="char_filter")] [JsonFormatter(typeof(SingleOrEnumerableFormatter))] IEnumerable CharFilter { get; set; } /// /// An optional list of logical / registered name of token filters. /// [DataMember(Name ="filter")] [JsonFormatter(typeof(SingleOrEnumerableFormatter))] IEnumerable Filter { get; set; } } /// public class CustomNormalizer : NormalizerBase, ICustomNormalizer { public CustomNormalizer() : base("custom") { } /// public IEnumerable CharFilter { get; set; } /// public IEnumerable Filter { get; set; } } /// public class CustomNormalizerDescriptor : NormalizerDescriptorBase, ICustomNormalizer { protected override string Type => "custom"; IEnumerable ICustomNormalizer.CharFilter { get; set; } IEnumerable ICustomNormalizer.Filter { get; set; } /// public CustomNormalizerDescriptor Filters(params string[] filters) => Assign(filters, (a, v) => a.Filter = v); /// public CustomNormalizerDescriptor Filters(IEnumerable filters) => Assign(filters, (a, v) => a.Filter = v); /// public CustomNormalizerDescriptor CharFilters(params string[] charFilters) => Assign(charFilters, (a, v) => a.CharFilter = v); /// public CustomNormalizerDescriptor CharFilters(IEnumerable charFilters) => Assign(charFilters, (a, v) => a.CharFilter = v); } }