1. Add a synonym interface

request method

• Request method: POST
• Request URL: /v1/ctai/add_ctai_synonym
• Content-Type: application/json

request parameters

{
    "ctai_synonym_entity": {
        "ctai_entity": {
            "content": "potatoes"
        },
        "ctai_synonym_list": [
            {
                "content": "potatoes"
            },
            {
                "content": "Potato"
            },
            {
                "content": "Potato"
            }
        ]
    }
}

parameter	Enterprise Type	required	Parameter Description
ctai_synonym_entity	object	Yes	Q&A Intervention Information Object
ctai_entity	object	Yes	entity word information object
ctai_synonym_list	array	Yes	synonym list
content	string	Yes	Entity word or synonym content

Response business parameters

{
    "ctsynonym_id": "test_id"
}

parameter	Enterprise Type	Parameter Description
ctsynonym_id	string	Added entity word id

2. Modify the synonym interface

request method

• Request method: POST
• Request URL: /v1/ctai/modify_ctai_synonym
• Content-Type: application/json

request parameters

{
    "ctsynonym_id": "test_id",
    "ctai_synonym_entity": {
        "ctai_entity": {
            "content": "potato"
        },
        "ctai_synonym_list": [
            {
                "content": "potato"
            },
            {
                "content": "Potato"
            },
            {
                "content": "Potato"
            }
        ]
    }
}

parameter	Enterprise Type	required	Parameter Description
ctsynonym_id	string	Yes	Entity word id
ctai_synonym_entity	object	Yes	Q&A Intervention Information Object
ctai_entity	object	Yes	entity word information object
ctai_synonym_list	array	Yes	synonym list
content	string	Yes	Entity word or synonym content

Response business parameters

• No response service parameters

3. Delete the synonym interface

request method

• Request method: POST
• Request URL: /v1/ctai/delete_ctai_synonym
• Content-Type: application/json

request parameters

{
    "ctsynonym_id": "test_id"
}

parameter	Enterprise Type	required	Parameter Description
ctsynonym_id	string	Yes	Entity word id, only one entity word can be deleted at a time

Response business parameters

• No response service parameters

4. Synonym information interface

request method

• Request method: POST
• Request URL: /v1/ctai/ctai_synonym_info
• Content-Type: application/json

request parameters

{
    "ctsynonym_id": "test"
}

parameter	Enterprise Type	required	Parameter Description
ctsynonym_id	string	Yes	Entity word id

Response business parameters

{
    "ctsynonym_id": "test",
    "ctai_entity": {
        "ctsynonym_id": "test",
        "content": "test",
        "create_time": "1684670811",
        "update_time": "1684670811 "
    },
    "ctai_synonym_list": [
        {
            "ctsynonym_id": "test",
            "ctai_synonym": {
                "ctsynonym_id": "test",
                "content": "test",
                "create_time": "1684670812",
                "update_time": "1684670812"
            }
        },
        // other synonyms
    ]
}

parameter	Enterprise Type	Parameter Description
ctsynonym_id	string	entity or synonym id
ctai_entity	object	entity word information object
ctai_synonym_list	array	synonym list
content	string	Entity word or synonym content
create_time	string	Creation time, integer timestamp, unit is second.
update_time	string	Modification time, integer timestamp, unit is second.

1. File type document upload interface

request method

• Request method: POST
• Request URL: /v1/ctai/ctai_synonym_list
• Content-Type: application/json

request parameters

{
    "ctsynonym_id": "test",
    "filter_syes_entity_content": "test",
    "filter_syes_synonym_content": "test",
    "filter_syes_keywords": "test",
    "sort_type": "test_id",
    "page" : "1",
    "page_rows": "1"
}

parameter	Enterprise Type	required	Parameter Description
ctsynonym_id	string	No	Entity word id, multiple separated by English commas
filter_sys_entity_content	string	No	Entity word search keywords, fuzzy matching
filter_sys_synonym_content	string	No	Synonym search keywords, fuzzy matching
filter_sys_keywords	string	No	Entity words or synonyms search keywords, fuzzy matching
sort_type	string	No	Sorting method, the default is create_time_asc create_time_asc Sort by creation time from old to new create_time_desc Sort by creation time from new to old update_time_asc Sort by modification time from old to new update_time_desc Sort by modification time from new to old
page	string	No	Paging parameters, the number of pages, starting from 1, the default is 1
page_rows	string	No	Pagination parameters, how many items per page, the default is 1

Response business parameters

{
    "total_count": "3",
    "ctai_synonym_entity_list": [
        {
            "ctsynonym_id": "test",
            "ctai_entity": {
                "ctsynonym_id": "test",
                "content": "test" ,
                "create_time": "1684670811",
                "update_time": "1684670811"
            },
            "ctai_synonym_list": [
                {
                    "ctsynonym_id": "test",
                    "ctai_synonym": {
                        "ctsynonym_id": " test",
                        "content": "test",
                        "create_time": "1684670812",
                        "update_time": "1684670812"
                    }
                },
                // other synonyms
            ]
        },
        // other entity words
    ]
}

parameter	Enterprise Type	Parameter Description
total_count	string	The total number of entity words, used for pagination.
ctai_synonym_entity_list	array	entity word list