/** * Synapse REST API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { ColumnAnalyzerOverrideEntry } from './ColumnAnalyzerOverrideEntry'; /** *

A shareable bundle of per-column analyzer assignments. Each entry binds one column to an analyzer; that analyzer's analyzer.default drives the column's index-time analyzer and (if declared) analyzer.default_search drives its search-time analyzer — see OpenSearch's index analyzers and search analyzers. Overrides win over the SearchConfiguration's defaultAnalyzer for the named columns.

Example with $ref entries (preferred — supports reuse). Each entry's analyzer is a saved TextAnalyzer:

{
 *   "organizationName": "biomed",
 *   "name": "publication_columns",
 *   "overrides": [
 *     { "columnName": "disease_code", "analyzer": { "$ref": "biomed-acronym_exact" } },
 *     { "columnName": "authors",      "analyzer": { "$ref": "biomed-scientific_search" } }
 *   ]
 * }

Example with inline analyzer entries — each entry's analyzer is the bare OpenSearch settings.analysis block (allowed root keys: char_filter, tokenizer, filter, analyzer):

{
 *   "organizationName": "biomed",
 *   "name": "publication_columns_inline",
 *   "overrides": [
 *     {
 *       "columnName": "disease_code",
 *       "analyzer": {
 *         "analyzer": {
 *           "default": {
 *             "type": "custom",
 *             "tokenizer": "keyword",
 *             "filter": ["lowercase"]
 *           }
 *         }
 *       }
 *     },
 *     {
 *       "columnName": "authors",
 *       "analyzer": { "$ref": "biomed-scientific_search" }
 *     }
 *   ]
 * }

The analyzer field on each entry accepts a {"$ref": "{organizationName}-{name}"} reference (preferred — supports reuse) or an inline analyzer literal. Refs to SynonymSets are not permitted inside an inline analyzer literal — save a TextAnalyzer and reference it by qualified name to use synonyms. Referenced from a SearchConfiguration's columnAnalyzerOverrides by qualified name {organizationName}-{name} or inlined directly there. Entries whose columnName is not present in a given SearchIndex's schema are silently skipped — a single override resource can therefore apply to multiple indexes that share some column names. Cannot be deleted while referenced by any SearchConfiguration.

* @export * @interface ColumnAnalyzerOverride */ export interface ColumnAnalyzerOverride { /** * The unique ID of this column analyzer override. * @type {string} * @memberof ColumnAnalyzerOverride */ id?: string; /** * The name of the Organization this resource belongs to. Immutable after creation. * @type {string} * @memberof ColumnAnalyzerOverride */ organizationName?: string; /** * The resource name. Must start with a letter and contain only letters, digits, and underscores. Unique within the organization and immutable after creation. Used as part of the qualified name ({organizationName}-{name}) when referenced by other resources. * @type {string} * @memberof ColumnAnalyzerOverride */ name?: string; /** * Optional description. * @type {string} * @memberof ColumnAnalyzerOverride */ description?: string; /** * The per-column analyzer assignments — see ColumnAnalyzerOverrideEntry. * @type {Array} * @memberof ColumnAnalyzerOverride */ overrides?: Array; /** * Synapse employs an Optimistic Concurrency Control (OCC) scheme. * @type {string} * @memberof ColumnAnalyzerOverride */ etag?: string; /** * The date this resource was created. * @type {string} * @memberof ColumnAnalyzerOverride */ createdOn?: string; /** * The ID of the user that created this resource. * @type {string} * @memberof ColumnAnalyzerOverride */ createdBy?: string; /** * The date this resource was last modified. * @type {string} * @memberof ColumnAnalyzerOverride */ modifiedOn?: string; /** * The ID of the user that last modified this resource. * @type {string} * @memberof ColumnAnalyzerOverride */ modifiedBy?: string; } /** * Check if a given object implements the ColumnAnalyzerOverride interface. */ export declare function instanceOfColumnAnalyzerOverride(value: object): value is ColumnAnalyzerOverride; export declare function ColumnAnalyzerOverrideFromJSON(json: any): ColumnAnalyzerOverride; export declare function ColumnAnalyzerOverrideFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnAnalyzerOverride; export declare function ColumnAnalyzerOverrideToJSON(json: any): ColumnAnalyzerOverride; export declare function ColumnAnalyzerOverrideToJSONTyped(value?: ColumnAnalyzerOverride | null, ignoreDiscriminator?: boolean): any;