> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Find and Replace

> Index pipeline stage configuration specifications

export const schema = {
  "type": "object",
  "title": "Find and Replace",
  "description": "Performs pattern-based find and replace operations on specified document fields using regular expressions or literal string matching. Supports multiple simultaneous replacements, case-sensitive or insensitive matching, and global or first-occurrence replacement modes. Enables data cleansing, format normalization, and content standardization at index time.",
  "properties": {
    "skip": {
      "type": "boolean",
      "title": "Skip This Stage",
      "description": "Controls whether this stage executes during pipeline processing at runtime. When set to `true`, the stage is completely bypassed and documents pass through unchanged to the next stage. Useful for A/B testing, gradual rollouts, or temporarily disabling a stage without removing it from the pipeline.",
      "default": false,
      "hints": ["advanced"]
    },
    "label": {
      "type": "string",
      "title": "Label",
      "description": "Human-readable identifier displayed in the Fusion Admin UI, monitoring dashboards, and log messages. Use descriptive labels like `Parse Product PDFs` to aid debugging and team collaboration. Labels appear in performance metrics and error reports, making it easier to identify which stage failed.",
      "hints": ["advanced"],
      "maxLength": 255
    },
    "condition": {
      "type": "string",
      "title": "Condition",
      "description": "JavaScript expression evaluated at runtime on each document to conditionally execute this stage. The expression must return `true` to execute or `false` to skip. Access document fields using `doc.getFieldValue('fieldName')` and request parameters via `request.getFirstParam('paramName')`. For example, `doc.getFieldValue('type') === 'premium'` executes this stage only for premium content.",
      "hints": ["code", "code/javascript", "advanced"]
    },
    "findListReplaceRules": {
      "type": "array",
      "title": "Find List Replace rules",
      "items": {
        "type": "object",
        "required": ["sourceField", "listLocation"],
        "properties": {
          "sourceField": {
            "type": "string",
            "title": "Source Field",
            "description": "Name of the field in the source document from which data will be read and processed by this stage. The value from this field serves as input for the stage's transformation, parsing, or enrichment logic. Supports both static field names like `title`, `description`, or `content`, as well as dynamic field patterns using wildcards or expressions."
          },
          "listLocation": {
            "type": "string",
            "title": "Blob Name of the List",
            "reference": "blob",
            "blobType": "unspecified"
          },
          "replacementValue": {
            "type": "string",
            "title": "Replacement Value"
          },
          "caseSensitive": {
            "type": "boolean",
            "title": "Case Sensitive",
            "default": true
          }
        }
      }
    },
    "findReplaceRules": {
      "type": "array",
      "title": "Find replace rules",
      "items": {
        "type": "object",
        "required": ["sourceField", "keyValues"],
        "properties": {
          "sourceField": {
            "type": "string",
            "title": "Source Field",
            "description": "Name of the field in the source document from which data will be read and processed by this stage. The value from this field serves as input for the stage's transformation, parsing, or enrichment logic. Supports both static field names like `title`, `description`, or `content`, as well as dynamic field patterns using wildcards or expressions."
          },
          "caseSensitive": {
            "type": "boolean",
            "title": "Case sensitive",
            "default": true
          },
          "keyValues": {
            "type": "array",
            "title": "find and replace strings list",
            "items": {
              "type": "object",
              "required": ["key"],
              "properties": {
                "key": {
                  "type": "string",
                  "title": "Parameter Name"
                },
                "value": {
                  "type": "string",
                  "title": "Parameter Value"
                }
              }
            }
          }
        }
      }
    }
  },
  "category": "Field Transformation",
  "categoryPriority": 7,
  "unsafe": false
};

export const SchemaParamFields = ({schema}) => {
  const sanitize = str => {
    if (typeof str !== "string") return str;
    return str.replace(/^"(.*)"$/s, "$1").replace(/\\/g, "").replace(/"/g, "'");
  };
  const renderMd = str => {
    const s = sanitize(str);
    const text = (/[.!?]\)*$/).test(s) ? s : `${s}.`;
    return text.split(/(\*\*[^*]+\*\*|_[^_]+_|`[^`]+`)/g).map((part, i) => {
      if (part.startsWith("**")) return <strong key={i}>{part.slice(2, -2)}</strong>;
      if (part.startsWith("_")) return <em key={i}>{part.slice(1, -1)}</em>;
      if (part.startsWith("`")) return <code key={i}>{part.slice(1, -1)}</code>;
      return part;
    });
  };
  const {description, properties = {}, required: requiredProps = []} = schema;
  const visibleProps = useMemo(() => Object.entries(properties).filter(([, prop]) => !prop.hints?.includes("hidden")), [properties]);
  const renderProp = ([name, prop]) => {
    const isRequired = requiredProps.includes(name);
    const hasDefault = prop.default !== undefined;
    const rawDefault = prop.default;
    const hints = prop.hints || [];
    const isComplexDefault = hasDefault && (typeof rawDefault === "object" || typeof rawDefault === "string" && (rawDefault.length > 20 || rawDefault.includes('"')));
    const postBadges = [];
    if (prop.title) {
      postBadges.push(<><span className="text-stone-400 dark:text-stone-500">API property: </span>{name}</>);
    }
    const constraints = [];
    if (prop.minimum !== undefined && prop.maximum !== undefined) {
      constraints.push(`Range: ${prop.minimum} – ${prop.maximum}`);
    } else if (prop.minimum !== undefined) {
      constraints.push(`Min: ${prop.minimum}`);
    } else if (prop.maximum !== undefined) {
      constraints.push(`Max: ${prop.maximum}`);
    }
    if (prop.minLength !== undefined && prop.maxLength !== undefined) {
      constraints.push(`Length: ${prop.minLength} – ${prop.maxLength}`);
    } else if (prop.minLength !== undefined) {
      constraints.push(`Min length: ${prop.minLength}`);
    } else if (prop.maxLength !== undefined) {
      constraints.push(`Max length: ${prop.maxLength}`);
    }
    const fieldProps = {
      key: name,
      body: prop.title || name,
      type: prop.type,
      ...postBadges.length > 0 && ({
        post: postBadges
      }),
      ...isRequired && ({
        required: true
      }),
      ...!isComplexDefault && hasDefault ? {
        default: sanitize(String(rawDefault))
      } : {}
    };
    const isObject = prop.type === "object" && prop.properties;
    const isArrayOfObjects = prop.type === "array" && prop.items?.type === "object" && prop.items.properties;
    return <ParamField {...fieldProps}>
        {prop.description && <p>{renderMd(prop.description)}</p>}

        {prop.enum && <p>
            Allowed values: 
            {prop.enum.map((v, i) => <>{i > 0 && ", "}<code key={i}>{String(v)}</code></>)}
          </p>}

        {constraints.length > 0 && <p className="text-stone-500 dark:text-stone-400 text-sm">
            {constraints.join(" · ")}
          </p>}

        {isComplexDefault && <div className="flex">
            <p>
              <strong>Default:</strong>
            </p>
            <pre className="!my-0">
              <code>
                {JSON.stringify(rawDefault, null, 2)}
              </code>
            </pre>
          </div>}

        {isArrayOfObjects && <Expandable title="item properties">
            <SchemaParamFields schema={{
      properties: prop.items.properties,
      required: prop.items.required
    }} />
          </Expandable>}

        {isObject && <Expandable title="properties">
            <SchemaParamFields schema={{
      properties: prop.properties,
      required: prop.required
    }} />
          </Expandable>}
      </ParamField>;
  };
  return <div>
      {description && <p>{renderMd(description)}</p>}

      {visibleProps.map(renderProp)}
    </div>;
};

export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => {
  const [isLoaded, setIsLoaded] = useState(false);
  useEffect(() => {
    const timer = setTimeout(() => {
      setIsLoaded(true);
    }, 500);
    return () => clearTimeout(timer);
  }, []);
  return <div className="lw-template-container">
      <Card title={title} icon={icon}>
        {isLoaded && <span dangerouslySetInnerHTML={{
    __html: `<lw-template id="a029c1a9-28be-427e-b0e1-5d918920246a"></lw-template
            >`
  }} />}
        <Link href={linkHref} className="agent-studio-link text-left text-gray-600 gap-2 dark:text-gray-400 text-sm font-medium flex flex-row items-center hover:text-primary dark:hover:text-primary-light group-hover:text-primary group-hover:dark:text-primary-light">Powered by Lucidworks Agent Studio</Link>
      </Card>
    </div>;
};

[localhost link]: http://localhost:3000/docs/lucidworks-search/09-developer-documentation/config-specs/index-pipeline-stages/find-replace

[mintlify link]: https://doc.lucidworks.com/docs/lucidworks-search/09-developer-documentation/config-specs/index-pipeline-stages/find-replace

[old doc.lw link]: https://doc.lucidworks.com/managed-fusion/5.9/782neo

The Find and Replace stage uses exact string matching to standardize or remove a set of specific passages, phrases, or words from a document field.

This stage is configured with one or more rules. Each rule specifies:

* One or more text strings to search for matching text (phrases or words)
* A *single* text string that is the replacement value

<Note>
  **Important**

  When the replacement string is empty, the system deletes the matched text from the document field.
</Note>

Configure the Find and Replace stage in one of the following ways:

* [Lucidworks Search blob store setup](#managed-fusion-blob-store-setup)
* [Lucidworks Search UI or REST API setup](#managed-fusion-ui-or-rest-api-setup)

<LwTemplate />

### Lucidworks Search blob store setup

Setting up the stage using Lucidworks Search’s blob store is referred to as **Find - List - Replace**.

The general procedure for *each* find/list/replace action is:

* Upload a file that contains a list of text passages to be standardized into the [Lucidworks Search Blob Store](/api-reference/blobs/get-blob-store-service-status).
* Each file:

  * Contains one line for each text passage
  * Has a `.lst` suffix

The required rule properties to standardize the text are the:

* Document field to scan
* Name of the `.lst` file uploaded to the blob store

  <Note>
    The `.lst` suffix must be included in the file name designated in the rule.
  </Note>
* Value of the replacement text

<Note>
  **Important**
  Multiple `.lst` files can be uploaded and used to perform find/replace actions.
</Note>

#### Example

One example could be to remove the country information and replace it with the phrase: **country not displayed for security purposes** to make the data anonymous for reporting.

* The document field to scan is **country**.
* The name of the `.lst` file in this example is `country.lst`. An excerpt is:

```txt theme={"dark"}
Afghanistan
Afrique
Albania
Albanie
Alderney
Algeria
Algérie
Allemagne
America
Amérique
Amériques
American Samoa
Andorra
Andorre
Angleterre
Anglo-Normandes
Angola
Anguilla
Antigua and Barbuda
Antigua et Barbuda
Antilles
Antilles Néerlandaises
Arabie Saoudite
Argentina
Argentine
Arménie
Aruba
```

* The value of the replacement text is: **country not displayed for security purposes**.

If the text of the passages scanned includes any of the items in the `country.lst` file, it is replaced with the phrase: **country not displayed for security purposes**.

### Lucidworks Search UI or REST API setup

Setting up the stage using the Lucidworks Search UI or REST API is referred to as **Find - Replace**.

The Lucidworks Search UI access path is:

* Sign in to Lucidworks Search.
* Select the application.
* Select **Indexing > Index Workbench**.
* Select **Add a Stage**.
* Select **Find and Replace** in the Field Transformation section.
* Enter values in the fields as described in the [Configuration section](#configuration).

  <Note>
    The REST API uses the parameters specified below.
  </Note>

The required rule properties to standardize the text are the:

* Document field to scan
* List of find/replace pairs

## Configuration

<Tip>
  When entering configuration values in the UI, use *unescaped* characters, such as `\t` for the tab character. When entering configuration values in the API, use *escaped* characters, such as `\\t` for the tab character.
</Tip>

<SchemaParamFields schema={schema} />