> ## 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 Stage

export const schema = {
  "type": "object",
  "title": "Find and Replace",
  "description": "Find strings from a list and replace them",
  "properties": {
    "skip": {
      "type": "boolean",
      "title": "Skip This Stage",
      "description": "Set to true to skip this stage.",
      "default": false,
      "hints": ["advanced"]
    },
    "label": {
      "type": "string",
      "title": "Label",
      "description": "A unique label for this stage.",
      "hints": ["advanced"],
      "maxLength": 255
    },
    "condition": {
      "type": "string",
      "title": "Condition",
      "description": "Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.",
      "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"
          },
          "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"
          },
          "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 formatDescription = str => {
    const s = sanitize(str);
    return (/[.!?]\)*$/).test(s) ? s : `${s}.`;
  };
  const {description, properties = {}, required: requiredProps = []} = schema;
  const visibleProps = useMemo(() => Object.entries(properties).filter(([, prop]) => !prop.hints?.includes("hidden")), [properties]);
  return <div>
      {description && <p>{formatDescription(description)}</p>}

      {visibleProps.map(([name, prop]) => {
    const isRequired = requiredProps.includes(name);
    const hasDefault = prop.default !== undefined;
    const rawDefault = prop.default;
    const isComplexDefault = hasDefault && (typeof rawDefault === "object" || typeof rawDefault === "string" && (rawDefault.length > 20 || rawDefault.includes('"')));
    const fieldProps = {
      key: name,
      body: prop.title || name,
      type: prop.type,
      ...prop.title && ({
        post: [<><span className="text-stone-400 dark:text-stone-500">API property: </span>{name}</>]
      }),
      ...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>{formatDescription(prop.description)}</p>}

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

            {isArrayOfObjects && <div className="flex">
              <p>
                <strong>Object attributes:</strong>
              </p>
              <pre className="!my-0">
                <code>
                  {'{\n'}
                  {Object.entries(prop.items.properties).map(([iname, iprop]) => <>
                      {`  ${iname}`}
                      {prop.items?.required?.includes(iname) && <span style={{
      color: 'red'
    }}> required</span>}
                      {`: {\n    display name: ${sanitize(iprop.title || '')}\n    type: ${iprop.type}\n  }\n`}
                    </>)}
                  {'}'}
                </code>
              </pre>
              </div>}

            {isObject && <Expandable title="properties">
                <SchemaParamFields schema={{
      properties: prop.properties,
      required: prop.required
    }} />
              </Expandable>}
          </ParamField>;
  })}
    </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/5/fusion/reference/config-ref/pipeline-stages/index-stages/find-replace-index-stage

[mintlify link]: https://doc.lucidworks.com/docs/5/fusion/reference/config-ref/pipeline-stages/index-stages/find-replace-index-stage

[old doc.lw link]: https://doc.lucidworks.com/fusion/5.9/213

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

<Tip>
  **Important**

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

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

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

<LwTemplate />

### Fusion blob store setup

Setting up the stage using Fusion’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 [Fusion 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

<Tip>
  **Important**

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

#### 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**.

### Fusion UI or REST API setup

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

The Fusion UI access path is:

* Sign in to Fusion.
* 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} />