This web service allows users with the ADMIN role to list AI profiles.
It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.
For more information about AI profiles, see AI profile.
| Method | Endpoint |
|---|---|
GET |
|
Response body
[
{
"id": "9b7125ad-23a6-4090-83ac-60dab2b7b34e",
"profileType": "CHATBOT",
"name": "helper",
"profileId": "helper",
"apiKey": "XXX",
"authenticationMethod": {
"type": "api_key",
"label": "API key",
"authenticationParameters": [
{
"label": "API key",
"key": "api_key",
"value": "XXX",
"isSecret": true,
"isOptional": false
}
]
},
"customPrompt": "This is my custom prompt."
}
]
| Field | Type | Description |
|---|---|---|
id |
String | The unique identifier for the profile. |
profileType |
String | The type of the profile. Can be AGENTIC_CHATBOT, COMPLETION, CHATBOT, GENERIC_AGENT, or TRANSLATION. |
name |
String | The name of the profile. |
profileId |
String | The profile ID of the profile. It can only include alphanumeric characters, hyphens (-), and underscores (_). |
apiKey |
String | The API key for the Large Language Model (LLM) provider or translation provider. |
authenticationMethod |
Object | Contain the details for the authentication to the provider. |
type |
String | The type of authentication. |
label |
String | The label for the type of authentication. |
authenticationParameters |
List of objects | The list of parameters to connect to the provider. |
label |
String | The label for the authentication parameter. |
key |
String | The key for the authentication parameter. |
value |
String | The value for the authentication parameter. |
isSecret |
Boolean | Whether the parameter is secret or not. |
isOptional |
Boolean | Whether the parameter is optional or not. |
numSemanticSearchResults |
Number | 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. By default, the value is 5. |
numSemanticSearchResultsAfterRerank |
Number | The number of semantic search results provided to the large language model (LLM) after reranking. The value must be smaller or equal to the value of the numSemanticSearchResults field. |
ragPrompt |
String | A Retrieval-augmented generation (RAG) prompt. Asks the user question to the LLM. It must have the {relevant_documents} variable, and the {chatbot_instructions} variable for Chatbot profiles. {relevant_documents} dynamically contains the relevant documents (gotten through the Clustered semantic search web service), and {chatbot_instructions} is the customPrompt value. |
ragHistoryPrompt |
String | A Retrieval-augmented generation (RAG) history prompt. Asks the LLM to transform the user question and the conversation history into a standalone question asked to the LLM. |
translationAdvancedSettings |
String | Only with TRANSLATION profiles. Parameters for the translation engine. Accepts JSON as a string. |
translationDestinationLanguages |
Array | Only with TRANSLATION profiles. A list of target languages available to end users in On-demand translation components that use this profile. The expected format depends on the translation provider. For example, it may be fr or fr-FR for French. |
customPrompt |
String | The LLM prompt. The prompt can contain variables. Place variables in single curly brackets. Users can set the values of variables when using the AI method in Custom components, or the Query a large language model (LLM) web service. |
relevantMetadata |
String | Only with AGENTIC_CHATBOT and GENERIC_AGENT profiles. relevantMetadata allow the agent to use metadata filters for their queries. relevantMetadata contains a stringified JSON array of metadata objects, each containing a key identifier, an array of values, and a description. Proper description on how and when to use metadata filters is essential. If the agentic chatbot runs a query with filters and gets no response, it runs the query again. |
promoteRules |
String | Only with AGENTIC_CHATBOT and GENERIC_AGENT profiles. promoteRules uses metadata to indicate which variant of a document is the most relevant in a document cluster. For example "version": "latest". promoteRules contains a stringified JSON array of metadata objects, each containing a key identifier, and an array of values.
|
agentPrompt |
String | Only with AGENTIC_CHATBOT and GENERIC_AGENT profiles. The agentPrompt defines specific instructions and the conversation scope for the bot. For optimal results, add specific instructions that are relevant to your context. Below are a few examples:
|
agentTools |
Array | Only with GENERIC_AGENT profiles. agentTools defines tools that the agent has access to. The only available value is semsearch. |
responseJson |
String | Only with GENERIC_AGENT profiles. The stringified JSON schema representing the format of the response. responseJson cannot contain the top-level field title. |
| Return code | Description |
|---|---|
200 OK |
The profile was created successfully. |
401 UNAUTHORIZED |
The authorization header is absent or invalid. |
For a comprehensive list of all possible return codes, see Return codes.
- This web service returns the profiles list and updates in real time.
- This web service does not list deleted profiles.
- See the Analytics AI profiles web service to list profiles used to trigger AI events.