Change a generative AI profile - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service allows users with the ADMIN role to change a generative AI profile.

For more information about generative AI profiles, see Generative AI.

Method Endpoint
PUT 
/api/admin/ai/profiles/{id}

Request example

{
  "name": "summarize",
  "profileId": "summarize",
  "apiKey": "XXX",
  "customPrompt": "Can you write a concise and comprehensive summary of {topic}? The topic is formatted using HTML. Ignore the HTML formatting and focus on the actual text.\n\nYou must begin your message by \"Hi {name}!\".\n\nYou must be concise. Your message should be shorter than the original topic."
}
Field Type Required? Description
name String No The name of the profile.
profileId String No The profile ID of the profile.
profileType String No The type of the profile. Can be COMPLETION or CHATBOT.
apiKey String No The API key for the Large Language Model (LLM) provider.
It is only possible to create an Open AI profile.
customPrompt String No The LLM prompt. The prompt can contain variables. Variables are surrounded by single curly brackets. Users can set the values of variables when using the Query a large language model (LLM) web service.
numSemanticSearchResults Number No Defines the number of semantic search results provided to the large language model (LLM) when calling the Retrieval-augmented generation web service. The value can range from 1 to 20. If no value is set, the default number is 5. Users can only set this field when profileType has a value of CHATBOT.
A higher number of semantic search results can increase the cost of requests, and decrease the speed and quality of answers. For most use cases, use the default value of 5.
The Chatbot component calls the Retrieval-augmented generation web service.

Response body

This web service does not return a response body when successful.

Return code Description
200 OK The profile was changed successfully.
401 UNAUTHORIZED The authorization header is absent or invalid.

For a comprehensive list of all possible return codes, see Return codes.