strings-merger.md

Azure Cognitive Search Python Custom Skill For Strings Concatenation

This code is a Python Custom Skill, for Azure Cognitive Search, based on Azure Functions for Python. It merges 2 strings in a third one, useful when you want to concatenate, within an Enrichment Pipeline, the file name or path with the content. This skill is indicated for scenarios when the file name or path have dates, organizations, names, or key phrases.

Until January 2020, you can't do this merge usint the Built In Merge Skill since you won't have the required offistes. I just suggested this feature as a built in capability. For now, this code is the alternative.

Required steps

1. Follow this tutorial.
2. Use the Python code below as your init.py file. Customize it with your storage account details, also with your csv file name and target column. As you can see below, my sample csv file target column name is Term. That helps the idea that this code will extract pre-defined terms from the documents content.
3. Don't forget to add azure.functions to your requirements.txt file.
4. Connect your published custom skill to your Cognitive Search Enrichment Pipeline. Plesae check the section below the code in this file. For more information, click here.

Python Code

The Python code for this skill is here.

Add this skill to your Azure Cogntive Search Enrichment Pipeline

Your skillset will have this extra section below.

 {
            "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
            "name": "Concatenate Strings",
            "description": "Merge Content and File name",
            "context": "/document",
            "uri": "your-Pyhton-Azure-Functions-published-URL",
            "httpMethod": "POST",
            "timeout": "PT30S",
            "batchSize": 1,
            "degreeOfParallelism": null,
            "inputs": [
             {
               "name": "string1",
               "source": "/document/metadata_storage_name"
             },
             {
               "name": "string2",
               "source": "/document/content"
             }
                   ],
        "outputs": [
          {
            "name": "text",
            "targetName": "concatenatedText"
          }
            ],
            "httpHeaders": {}
           }

Sample Input

Use the JSON input below to test your function. Get familiar with the code behavior in the different situations.

This test text is a tribute to the most popular football club in the world, Flamengo, from Rio de Janeiro. It was founded in 1895 and has over 45 million fans in Brazil alone. The team was champion in its two most important matches of 2019, the Brazilian championship and the Copa Libertadores of America.

{
    "values": [
      {
        "recordId": "0",
        "data":
           {
             "string1": "Flamengo is",
             "string2": "the new champion"
           }
      },
        
      {
        "recordId": "1",
        "data":
           {
            "string1": "Flamengo_Libertadores_2019.jpg"
            }
      },
        {
        "recordId": "2",
        "data":
           {
            "string1": "Flamengo_Libertadores_2019.jpg",
            "string2": "",

            }
        },
    ]
}

Expected Output

{
    "values": [{
        "recordId": "0",
        "data": {
            "text": "Flamengo is the new champion"
        }
    }, {
        "recordId": "1",
        "data": "{}",
        "errors": [{
            "message": "Error:\'string2\' field is required in \'data\' object."
        }]
    }, {
        "recordId": "2",
        "data": {
            "text": "Flamengo_Libertadores_2019.jpg "
        }
    }]
}