Example Sentences
Generate Example Sentences
Generates Example Sentences for an Intent using generative AI.
post/v2.0/flows/{flowId}/intents/{intentId}/sentences/generate
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.
Path parameters
flowIdstring required
The unique identifier for the Flow.
intentIdstring required
The unique identifier for the Intent.
Query parameters
localeIdstring
The 24-character unique identifier for the Locale used to generate Example Sentences.
limitinteger
The maximum number of Example Sentences to generate for the Intent. The value must be between 5 and 20. The default is 5.
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.
Response
Returns array of sentences
string[] required
Changes
No recorded changes to this operation across all 1 revision of this API.