Creating an Index

This documentation explains how to select specific fields in your search index that you want to make searchable when creating an index.

1. Uploading your data to ConvoSearch

JSON Format

[
    {
        "id": "1",
        "name": "John Doe",
        "description": "A description of John Doe",
        "tags": ["example", "sample"],
        "image": "url_to_john_doe_image.jpg"
    },
    {
        "id": "2",
        "name": "Jane Smith",
        "description": "A description of Jane Smith",
        "tags": ["example", "sample"],
        "image": "url_to_jane_smith_image.jpg"
    },
    {
        "id": "3",
        "name": "Alice Johnson",
        "description": "A description of Alice Johnson",
        "tags": ["example", "sample"],
        "image": "url_to_alice_johnson_image.jpg"
    }
]

XML Format

<channel>
    <item>
        <id>1</id>
        <name>John Doe</name>
        <description>A description of John Doe</description>
        <tags>
            <tag>example</tag>
            <tag>sample</tag>
        </tags>
        <image>url_to_john_doe_image.jpg</image>
    </item>
    <item>
        <id>2</id>
        <name>Jane Smith</name>
        <description>A description of Jane Smith</description>
        <tags>
            <tag>example</tag>
            <tag>sample</tag>
        </tags>
        <image>url_to_jane_smith_image.jpg</image>
    </item>
    <item>
        <id>3</id>
        <name>Alice Johnson</name>
        <description>A description of Alice Johnson</description>
        <tags>
            <tag>example</tag>
            <tag>sample</tag>
        </tags>
        <image>url_to_alice_johnson_image.jpg</image>
    </item>
</channel>

CSV Format

id, name, description, tags, image
1, "John Doe", "A description of John Doe", "example;sample", "url_to_john_doe_image.jpg"
2, "Jane Smith", "A description of Jane Smith", "example;sample", "url_to_jane_smith_image.jpg"
3, "Alice Johnson", "A description of Alice Johnson", "example;sample", "url_to_alice_johnson_image.jpg"

2. Identify ID and image Keys

Unique Identifier: Choose a unique identifier for each record, such as an ID or SKU. This ensures each entry is distinct and easily retrievable. Image Fields: Select image fields that accurately represent your data. These fields are crucial for image-based searches.

3. How to Select Searchable fields

Review your data structure and identify which fields contain the information that users are most likely to search for. Common fields include names, descriptions, and tags. In your index configuration, specify the fields you identified as searchable. After configuring your index, perform test searches to ensure that the selected fields are being searched as expected. Adjust your configuration as needed based on the results.