neural-search/src/main/java/org/opensearch/neuralsearch/highlight/SemanticHighlightingConstants.java at 584cbea22d60cd805aafb42b3f43a4c207fec83b · opensearch-project/neural-search · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 */
package org.opensearch.neuralsearch.highlight;

/**
 * Constants for semantic highlighting functionality
 */
public final class SemanticHighlightingConstants {
    // System-generated factory and processor types
    public static final String SYSTEM_FACTORY_TYPE = "semantic-highlighter";
    public static final String PROCESSOR_TYPE = "semantic_highlighting";
    public static final String QUERY_ENRICHER_TYPE = "semantic_highlighter_query_enricher";

    // Default processor tags and descriptions
    public static final String DEFAULT_PROCESSOR_TAG = "semantic-highlighter";
    public static final String DEFAULT_PROCESSOR_DESCRIPTION = "System-generated semantic highlighting processor";

    // configuration keys
    public static final String HIGHLIGHTER_TYPE = "semantic";
    public static final String MODEL_ID = "model_id";
    public static final String BATCH_INFERENCE = "batch_inference";
    public static final String MAX_INFERENCE_BATCH_SIZE = "max_inference_batch_size";
    public static final String PRE_TAG = "pre_tag";
    public static final String POST_TAG = "post_tag";
    public static final String ENCODER = "encoder";
    public static final String NO_MATCH_SIZE = "no_match_size";

    // Search request ext block name. Setting this ext to {@code true} signals that
    // semantic highlighting should run via the system-generated batch processor —
    // an alternative to declaring {@code batch_inference: true} on every field.
    public static final String EXT_NAME = "semantic_highlighting_batch";

    // Connector parameter keys for batch configuration
    public static final String CONNECTOR_SUPPORTS_BATCH_INFERENCE = "supports_batch_inference";
    public static final String CONNECTOR_MAX_BATCH_SIZE = "max_batch_size";

    // Default values
    public static final String DEFAULT_PRE_TAG = "<em>";
    public static final String DEFAULT_POST_TAG = "</em>";
    public static final int DEFAULT_MAX_INFERENCE_BATCH_SIZE = 100;
    public static final Boolean DEFAULT_BATCH_INFERENCE = false;
    public static final String DEFAULT_ENCODER = "default";
    public static final String ENCODER_HTML = "html";
    public static final int DEFAULT_NO_MATCH_SIZE = 0;

    // ML inference keys
    public static final String HIGHLIGHTS_KEY = "highlights";
    public static final String START_KEY = "start";
    public static final String END_KEY = "end";
    public static final String QUESTION_KEY = "question";
    public static final String CONTEXT_KEY = "context";
    public static final String INPUTS_KEY = "inputs";
}