{"swagger":"2.0","host":"api-aat.mol-vica.com","schemes":["http"],"info":{"description":"AAT Backend API","version":"1.1","title":"AAT API Documentation"},"securityDefinitions":{"JWTAuth":{"type":"apiKey","in":"header","name":"access_token"}},"paths":{"/":{"get":{"tags":["version"],"summary":"checks server health","responses":{"200":{"description":"returns server health","schema":{"type":"object","properties":{"version":{"type":"string"}}}}}}},"/user/signin":{"post":{"tags":["user"],"summary":"logs in user","parameters":[{"in":"body","name":"user signin details","required":true,"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"}}}}],"responses":{"200":{"description":"returns access token","schema":{"type":"object","properties":{"access_token":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/user/signup":{"post":{"tags":["user"],"summary":"creates account for new user","parameters":[{"in":"body","name":"user signup details","required":true,"schema":{"type":"object","properties":{"email":{"type":"string"},"password":{"type":"string"},"confirmed_password":{"type":"string"}}}}],"responses":{"200":{"description":"returns access token","schema":{"type":"object","properties":{"access_token":{"type":"string"}}}},"422":{"description":"invalid inputs"}}}},"/user/change-password":{"post":{"tags":["user"],"summary":"changes password","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"user password details","required":true,"schema":{"type":"object","properties":{"password":{"type":"string"},"new_password":{"type":"string"},"confirmed_password":{"type":"string"}}}}],"responses":{"200":{"description":"returns user details","schema":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/user":{"get":{"tags":["user"],"summary":"fetches user details","security":[{"JWTAuth":[]}],"responses":{"200":{"description":"returns user details","schema":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/audit/upload":{"post":{"tags":["audit"],"summary":"fetch file details and uploads s3","security":[{"JWTAuth":[]}],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"file","required":true,"type":"file","description":"file containing intents and training phrases in excel or csv"},{"in":"formData","name":"file_name","required":true,"type":"string","description":"file name"}],"responses":{"200":{"description":"returns audit","schema":{"type":"object","properties":{"extension":{"type":"string"},"name":{"type":"string"},"original":{"type":"string"},"headers":{"type":"object","properties":{"sheetname":{"type":"array","items":{"type":"string"}},"additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/audit/analysis":{"post":{"tags":["audit"],"summary":"creates audit and runs analysis","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"file details for analysis","required":true,"schema":{"type":"object","properties":{"file_name":{"type":"string"},"file_name_s3":{"type":"string"},"variation_name":{"type":"string"},"intent_name":{"type":"string"},"sheet_name":{"type":"string"},"is_dm_checked":{"type":"boolean"},"is_pm_checked":{"type":"boolean"},"is_sm_checked":{"type":"boolean"},"is_kg_checked":{"type":"boolean"}}}}],"responses":{"200":{"description":"returns audit","schema":{"type":"object","properties":{"id":{"type":"string"},"intent_name":{"type":"string"},"sheet_name":{"type":"string"},"template_name":{"type":"string"},"variation_name":{"type":"string"},"user_id":{"type":"string"},"file_name":{"type":"string"},"file_name_s3":{"type":"string"},"message":{"type":"string"},"status":{"type":"string"},"traceback":{"type":"string"},"is_dm_checked":{"type":"boolean"},"is_pm_checked":{"type":"boolean"},"is_sm_checked":{"type":"boolean"},"is_kg_checked":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/audits":{"get":{"tags":["audit"],"summary":"fetches audits","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"offset","type":"number","description":"starting index of audit"},{"in":"query","name":"limit","type":"number","description":"number of audits to fetch"}],"responses":{"200":{"description":"returns user details","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"audits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"sheet_name":{"type":"string"},"intent_name":{"type":"string"},"variation_name":{"type":"string"},"user_id":{"type":"string"},"file_name":{"type":"string"},"file_name_s3":{"type":"string"},"is_dm_checked":{"type":"boolean"},"is_pm_checked":{"type":"boolean"},"is_sm_checked":{"type":"boolean"},"is_kg_checked":{"type":"boolean"},"message":{"type":"string"},"status":{"type":"string"},"traceback":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/direct-match/matches":{"get":{"tags":["direct match"],"summary":"fetches first direct match per label","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of label"},{"in":"query","name":"limit","type":"number","description":"number of labels to fetch"}],"responses":{"200":{"description":"returns first direct match per label","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation":{"type":"string"},"intent":{"type":"string"},"label":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"number_of_conflicts":{"type":"number"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/direct-match/match":{"get":{"tags":["direct match"],"summary":"fetches direct matches of a label","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of direct match"},{"in":"query","name":"limit","type":"number","description":"number of direct matches to fetch"},{"in":"query","name":"label","type":"number","description":"label tagged to direct match"}],"responses":{"200":{"description":"returns direct matches of a label","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation":{"type":"string"},"intent":{"type":"string"},"label":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/partial-match/matches":{"get":{"tags":["partial match"],"summary":"fetches partial matches","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of partial match"},{"in":"query","name":"limit","type":"number","description":"number of partial matches to fetch"}],"responses":{"200":{"description":"returns partial matches","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation_a":{"type":"string"},"intent_a":{"type":"string"},"variation_b":{"type":"string"},"intent_b":{"type":"string"},"score":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/partial-match/match":{"get":{"tags":["partial match"],"summary":"fetches partial match","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"row_id","type":"number","description":"row index of partial match"}],"responses":{"200":{"description":"returns partial match of row id","schema":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation_a":{"type":"string"},"intent_a":{"type":"string"},"variation_b":{"type":"string"},"intent_b":{"type":"string"},"score":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/semantic-match/matches":{"get":{"tags":["semantic match"],"summary":"fetches first semantic match per label","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of label"},{"in":"query","name":"limit","type":"number","description":"number of labels to fetch"}],"responses":{"200":{"description":"returns first semantic match per label","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation":{"type":"string"},"intent":{"type":"string"},"keywords":{"type":"string"},"most_representative_sentence":{"type":"string"},"label":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"number_of_conflicts":{"type":"number"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/semantic-match/match":{"get":{"tags":["semantic match"],"summary":"fetches semantic matches of a label","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of semantic match"},{"in":"query","name":"limit","type":"number","description":"number of semantic matches to fetch"},{"in":"query","name":"label","type":"number","description":"label tagged to semantic match"}],"responses":{"200":{"description":"returns semantic match of specificed label","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation":{"type":"string"},"intent":{"type":"string"},"keywords":{"type":"string"},"most_representative_sentence":{"type":"string"},"label":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/knowledge-gap/matches":{"get":{"tags":["knowledge gap"],"summary":"fetch first knowledge gap per label","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of label"},{"in":"query","name":"limit","type":"number","description":"number of labels to fetch"}],"responses":{"200":{"description":"returns first knowledge gap per label","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation":{"type":"string"},"intent":{"type":"string"},"keywords":{"type":"string"},"most_representative_sentence":{"type":"string"},"label":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"number_of_conflicts":{"type":"number"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/knowledge-gap/match":{"get":{"tags":["knowledge gap"],"summary":"fetch knowledge gaps of a label","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"audit_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of knowledge gaps"},{"in":"query","name":"limit","type":"number","description":"number of knowledge gaps to fetch"},{"in":"query","name":"label","type":"number","description":"label tagged to knowledge gap"}],"responses":{"200":{"description":"returns knowledge gaps of a label","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"audit_id":{"type":"string"},"row_id":{"type":"number"},"variation":{"type":"string"},"intent":{"type":"string"},"keywords":{"type":"string"},"most_representative_sentence":{"type":"string"},"label":{"type":"number"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/agent/create":{"post":{"tags":["agent"],"summary":"creates new agent","security":[{"JWTAuth":[]}],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"credentials","required":true,"type":"file","description":"dialgflow agent credentials"}],"responses":{"200":{"description":"returns agent details","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_name":{"type":"string"},"user_id":{"type":"string"},"error":{"type":"string"},"intents_file_name":{"type":"string"},"log_file_name":{"type":"string"},"migrated_file_name":{"type":"string"},"status":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/agents":{"get":{"tags":["agent"],"summary":"fetches agents","security":[{"JWTAuth":[]}],"responses":{"200":{"description":"returns agent details","schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"agent_name":{"type":"string"},"user_id":{"type":"string"},"intent_file_name":{"type":"string"},"log_file_name":{"type":"string"},"migrated_file_name":{"type":"string"},"status":{"type":"string"},"is_deleted":{"type":"boolean"},"error":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/agent/delete":{"delete":{"tags":["agent"],"summary":"deletes agents","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"agent_id","required":true,"type":"string"}],"responses":{"200":{"description":"returns status","schema":{"type":"object","properties":{"status":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/migration/upload/flexanswer":{"post":{"tags":["migration"],"summary":"runs data transform on flexanswer dataset","security":[{"JWTAuth":[]}],"consumes":["multipart/form-data"],"parameters":[{"in":"formData","name":"file","required":true,"type":"file","description":"file containing dataset"},{"in":"formData","name":"agent_id","required":true,"type":"string","description":"id of agent"}],"responses":{"200":{"description":"returns job id of data transform","schema":{"type":"object","properties":{"job_id":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/migration/download/logs":{"get":{"tags":["migration"],"summary":"download error logs during data transform","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"log_file_name","type":"string","description":"log file name in s3"}],"responses":{"200":{"description":"returns AWS temporarily credentials to download file","schema":{"type":"object","properties":{"url":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/migration/download/intents":{"get":{"tags":["migration"],"summary":"download intents migrated during data transform","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"migrated_file_name","type":"string","description":"intent file name in s3"}],"responses":{"200":{"description":"returns AWS temporarily credentials to download file","schema":{"type":"object","properties":{"url":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/dialogflow/sync-dialogflow":{"post":{"tags":["dialogflow data layer"],"summary":"syncs from data layer to dialogflow","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"id of agent","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"}}}}],"responses":{"200":{"description":"returns job id of syncing","schema":{"type":"object","properties":{"job_id":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/dialogflow/sync-data-layer":{"post":{"tags":["dialogflow data layer"],"summary":"syncs from dialogglow to data layer","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"id of agent","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"}}}}],"responses":{"200":{"description":"returns job id of syncing","schema":{"type":"object","properties":{"job_id":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/dialogflow/download/intents":{"get":{"tags":["dialogflow data layer"],"summary":"downloads intents in dialogflow","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"intents_file_name","type":"string","description":"intent file name in s3"}],"responses":{"200":{"description":"returns AWS temporarily credentials to download file","schema":{"type":"object","properties":{"url":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/intents":{"get":{"tags":["intent"],"summary":"fetches intents","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"agent_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of intent"},{"in":"query","name":"limit","type":"number","description":"number of intents to fetch"}],"responses":{"200":{"description":"returns intents","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"matches":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"priority":{"type":"number"},"events":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object"}}}},"input_contexts":{"type":"array","items":{"type":"string"}},"output_contexts":{"type":"array","items":{"type":"object","properties":{"life_span_count":{"type":"number"},"name":{"type":"string"}}}},"name":{"type":"string"},"messages":{"type":"array","items":{"type":"object"}},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/intent":{"get":{"tags":["intent"],"summary":"fetches intent","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"intent_id","type":"string","description":"id of intent"}],"responses":{"200":{"description":"returns intent","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"priority":{"type":"number"},"events":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object"}}}},"input_contexts":{"type":"array","items":{"type":"string"}},"output_contexts":{"type":"array","items":{"type":"object","properties":{"life_span_count":{"type":"number"},"name":{"type":"string"}}}},"name":{"type":"string"},"messages":{"type":"array","items":{"type":"object"}},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/intent/create":{"post":{"tags":["intent"],"summary":"creates intent","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"intent details","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"priority":{"type":"number"},"events":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object"}}}},"messages":{"type":"array","items":{"type":"object"}},"input_contexts":{"type":"array","items":{"type":"string"}},"output_contexts":{"type":"array","items":{"type":"object","properties":{"life_span_count":{"type":"number"},"name":{"type":"string"}}}}}}}],"responses":{"200":{"description":"returns intent details","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"priority":{"type":"number"},"events":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object"}}}},"messages":{"type":"array","items":{"type":"object"}},"input_contexts":{"type":"array","items":{"type":"string"}},"output_contexts":{"type":"array","items":{"type":"object","properties":{"life_span_count":{"type":"number"},"name":{"type":"string"}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/intent/edit":{"post":{"tags":["intent"],"summary":"edits intent","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"intent details","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"intent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"priority":{"type":"number"},"events":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object"}}}},"messages":{"type":"array","items":{"type":"object"}},"input_contexts":{"type":"array","items":{"type":"string"}},"output_contexts":{"type":"array","items":{"type":"object","properties":{"life_span_count":{"type":"number"},"name":{"type":"string"}}}}}}}],"responses":{"200":{"description":"returns intent details","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"priority":{"type":"number"},"events":{"type":"array","items":{"type":"string"}},"parameters":{"type":"array","items":{"type":"object"}}}},"messages":{"type":"array","items":{"type":"object"}},"input_contexts":{"type":"array","items":{"type":"string"}},"output_contexts":{"type":"array","items":{"type":"object","properties":{"life_span_count":{"type":"number"},"name":{"type":"string"}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/intents/delete":{"post":{"tags":["intent"],"summary":"deletes intent","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"ids of intents","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"intent_ids":{"type":"array","items":{"type":"string"}},"is_all":{"type":"boolean"}}}}],"responses":{"200":{"description":"returns status","schema":{"type":"object","properties":{"status":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/entity-types":{"get":{"tags":["entity type"],"summary":"fetches entity types","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"agent_id","type":"string","description":"id of audit"},{"in":"query","name":"offset","type":"number","description":"starting index of entity type"},{"in":"query","name":"limit","type":"number","description":"number of entity types to fetch"}],"responses":{"200":{"description":"returns entity types","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"entity_types":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"auto_expansion_mode":{"type":"boolean"},"enable_fuzzy_extraction":{"type":"boolean"},"kind":{"type":"string"}}},"entities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/entity-type":{"get":{"tags":["entity type"],"summary":"fetches entity type","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"entity_type_id","type":"string","description":"id of entity type"}],"responses":{"200":{"description":"returns entity type","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"auto_expansion_mode":{"type":"boolean"},"enable_fuzzy_extraction":{"type":"boolean"},"kind":{"type":"string"}}},"entities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/entity-type/create":{"post":{"tags":["entity type"],"summary":"creates entity type","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"entity type details","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"auto_expansion_mode":{"type":"boolean"},"enable_fuzzy_extraction":{"type":"boolean"},"kind":{"type":"string"}}},"entities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}}}}}}],"responses":{"200":{"description":"returns entity type details","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"auto_expansion_mode":{"type":"boolean"},"enable_fuzzy_extraction":{"type":"boolean"},"kind":{"type":"string"}}},"entities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/entity-type/edit":{"post":{"tags":["entity type"],"summary":"edits entity type","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"entity type details","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"entity_type_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"auto_expansion_mode":{"type":"boolean"},"enable_fuzzy_extraction":{"type":"boolean"},"kind":{"type":"string"}}},"entities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}}}}}}],"responses":{"200":{"description":"returns entity type details","schema":{"type":"object","properties":{"id":{"type":"string"},"agent_id":{"type":"string"},"display_name":{"type":"string"},"config":{"type":"object","properties":{"auto_expansion_mode":{"type":"boolean"},"enable_fuzzy_extraction":{"type":"boolean"},"kind":{"type":"string"}}},"entities":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"synonyms":{"type":"array","items":{"type":"string"}}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/entity-types/delete":{"post":{"tags":["entity type"],"summary":"deletes entity types","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"ids of entity types","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"entity_type_ids":{"type":"array","items":{"type":"string"}}}}}],"responses":{"200":{"description":"returns status","schema":{"type":"object","properties":{"status":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/training-phrases":{"get":{"tags":["training phrase"],"summary":"fetches training phrases","security":[{"JWTAuth":[]}],"parameters":[{"in":"query","name":"intent_id","type":"string","description":"id of intent"},{"in":"query","name":"offset","type":"number","description":"starting index of training phrase"},{"in":"query","name":"limit","type":"number","description":"number of training phrases to fetch"}],"responses":{"200":{"description":"returns training phrases","schema":{"type":"object","properties":{"total":{"type":"number"},"has_next":{"type":"boolean"},"training_phrases":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"intent_id":{"type":"string"},"parts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"alias":{"type":"string"},"user_defined":{"type":"boolean"},"entity_type":{"type":"string"}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}}}}},"401":{"description":"unauthorized"},"422":{"description":"invalid inputs"}}}},"/training-phrase/create":{"post":{"tags":["training phrase"],"summary":"creates training phrase","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"training phrase details","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"intent_id":{"type":"string"},"parts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"alias":{"type":"string"},"user_defined":{"type":"boolean"},"entity_type":{"type":"string"}}}}}}}],"responses":{"200":{"description":"returns training phrase details","schema":{"type":"object","properties":{"id":{"type":"string"},"intent_id":{"type":"string"},"parts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"alias":{"type":"string"},"user_defined":{"type":"boolean"},"entity_type":{"type":"string"}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/training-phrase/edit":{"post":{"tags":["training phrase"],"summary":"edits training phrase","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"training phrase details","required":true,"schema":{"type":"object","properties":{"agent_id":{"type":"string"},"training_phrase_id":{"type":"string"},"parts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"alias":{"type":"string"},"user_defined":{"type":"boolean"},"entity_type":{"type":"string"}}}}}}}],"responses":{"200":{"description":"returns training phrase details","schema":{"type":"object","properties":{"id":{"type":"string"},"intent_id":{"type":"string"},"parts":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"alias":{"type":"string"},"user_defined":{"type":"boolean"},"entity_type":{"type":"string"}}}},"name":{"type":"string"},"is_deleted":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}},"/training-phrases/delete":{"post":{"tags":["training phrase"],"summary":"deletes training phrases","security":[{"JWTAuth":[]}],"parameters":[{"in":"body","name":"ids of training phrases","required":true,"schema":{"type":"object","properties":{"training_phrase_ids":{"type":"array","items":{"type":"string"}}}}}],"responses":{"200":{"description":"returns status","schema":{"type":"object","properties":{"status":{"type":"string"}}}},"422":{"description":"invalid inputs"},"401":{"description":"unauthorized access"}}}}}}