/* 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; using System.Collections.Generic; using System.Runtime.Serialization; using OpenSearch.Net.Utf8Json; namespace OpenSearch.Client { /// /// An analyzer of type custom that allows to combine a Tokenizer with zero or more Token Filters, /// and zero or more Char Filters. /// /// The custom analyzer accepts a logical/registered name of the tokenizer to use, and a list of /// logical/registered names of token filters. /// /// public interface ICustomAnalyzer : IAnalyzer { /// /// The logical / registered name of the tokenizer to use. /// [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; } /// /// When indexing an array of text values, OpenSearch inserts a fake "gap" between the last term of one value /// and the first term of the next value to ensure that a phrase query doesn’t match two terms from different array elements. /// Defaults to 100. /// [DataMember(Name ="position_increment_gap")] [JsonFormatter(typeof(NullableStringIntFormatter))] int? PositionIncrementGap { get; set; } /// /// An optional list of logical / registered name of char filters. /// [DataMember(Name ="tokenizer")] string Tokenizer { get; set; } } public class CustomAnalyzer : AnalyzerBase, ICustomAnalyzer { public CustomAnalyzer() : base("custom") { } /// public IEnumerable CharFilter { get; set; } /// public IEnumerable Filter { get; set; } /// public int? PositionIncrementGap { get; set; } /// public string Tokenizer { get; set; } } public class CustomAnalyzerDescriptor : AnalyzerDescriptorBase, ICustomAnalyzer { protected override string Type => "custom"; IEnumerable ICustomAnalyzer.CharFilter { get; set; } IEnumerable ICustomAnalyzer.Filter { get; set; } int? ICustomAnalyzer.PositionIncrementGap { get; set; } string ICustomAnalyzer.Tokenizer { get; set; } /// public CustomAnalyzerDescriptor Filters(params string[] filters) => Assign(filters, (a, v) => a.Filter = v); /// public CustomAnalyzerDescriptor Filters(IEnumerable filters) => Assign(filters, (a, v) => a.Filter = v); /// public CustomAnalyzerDescriptor CharFilters(params string[] charFilters) => Assign(charFilters, (a, v) => a.CharFilter = v); /// public CustomAnalyzerDescriptor CharFilters(IEnumerable charFilters) => Assign(charFilters, (a, v) => a.CharFilter = v); /// public CustomAnalyzerDescriptor Tokenizer(string tokenizer) => Assign(tokenizer, (a, v) => a.Tokenizer = v); /// public CustomAnalyzerDescriptor PositionIncrementGap(int? positionIncrementGap) => Assign(positionIncrementGap, (a, v) => a.PositionIncrementGap = v); } }