Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Conversation

Generate conversation starters for a service

Generate conversation starters for a service.

Permissions

This endpoint requires the following permissions:

  • Conversation:CreateConversation for a hypothetical new conversation created using the same setting.
post/v1/{organization}/conversation/conversation_starter

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

service_idstring required

The identifier of the service to create a conversation starter for.

service_version_set_namestring

The version set of the service to use. If not provided, the release version set is used.

facetsAmigoLibPydanticBaseModelStrippedNonemptyString1[] required

The facets that the generated conversation starter should be about. Each generated starter is related to some of these facets.

min_countinteger required

The minimum (inclusive) number of conversation starters to generate.

max_countinteger required

The maximum (inclusive) number of conversation starters to generate.

generation_instructionsstring required

Response

Succeeded.