Lexicons
Create a New Lexicon
Creates a Lexicon in a Project.
post/v2.0/lexicons
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2Authorization code/auth/oauth2/authorizePasswordToken URL/auth/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
resourceIdstring
An Id of a resource within the corresponding project to copy from
shouldGenerateLexiconEntriesboolean
Flag to allow the Lexicon creation to use the generative AI to generate entries.
languageCodestring
Example:en-US
Language code.
shouldGenerateSynonymsboolean
Flag to allow the Lexicon creation to use the generative AI to generate synonyms.
generateLexiconEntriesLimitinteger
Number of entries to be generated by the Generative AI.
defaultSlotstring
Default Slot where to associate the generated Lexicon entries.
Headers
Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
Request body
Example request
{
"name": "EU countries",
"description": "Countries members of the European Union, e.g. Spain"
}Response
Returns Lexicon metadata object.
Example response
{
"name": "EU countries",
"description": "Countries members of the European Union, e.g. Spain",
"createdAt": 1694518620,
"lastChanged": 1694518620
}Changes
No recorded changes to this operation across all 1 revision of this API.