Prompt Templates

The service returns configured prompt templates.
SecurityoAuthUser
Request
query Parameters

$lang required	string The knowledge base language used for retrieving response. Must be a language enabled in the system. Enum: "en-US" "en-GB" "fr-FR" "es-ES" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "sv-SE" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR"
department required	string The department name. Example: department=Service
useFor	string This parameter can be used to filter prompt templates based on the console for which the prompt is to be used. Enum: "advisor" "analytics" "knowledge" "custom" Example: useFor=knowledge
displayAt	string This parameter can be used to filter prompts based on where the prompt is to be displayed in the console. Enum: "chat" "email" "analytics" "article.content-area" "article.suggestion" "article.attachment" "article.metadata" "folder" "custom" Example: displayAt=article.metadata
Responses
200
PromptTemplates Response
204
No Content
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal server error
get/assist/prompttemplates
Request samples
curl
JavaScript
Node.js
Python
Response samples
application/json
{"promptTemplate": [{"name": "Generate Title",
"description": "Generate Title",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "I need your help as an experienced content writer to come up with a compelling title for the given article. The 'Article content:' is provided below. Your task is to create a catchy and engaging title that accurately reflects the main points discussed in the article. Remember to consider the target audience and the tone of the article when crafting the title. Avoid using generic or overused titles, and instead aim to capture readers' attention while still being informative.\n###\nArticle Content:\n{{article.content}} \n### Your output should be in the following format:\n <h1>\\\\\\*Insert Title Here\\\\\\*</h1>",
"fieldToUpdate": "article.title",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011640
},
{"name": "Change Tone",
"description": "Change Tone",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "Given the 'Content:', I want you to write it in a 'Tone:' tone.\n###\nContent:\n{{article.content}}\n Tone: \n{{user.input:Tone}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0,
"isSystemCreated": false,
"id": 260400000011641
},
{"name": "Summary",
"description": "Summary",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.metadata"
],
"instruction": "Given the following 'article:' , generate a short summary of it. \n###\narticle: \n{{article.content}}",
"fieldToUpdate": "article.summary",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011642
},
{"name": "Improve Article",
"description": "Improve Article",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "As an experienced content writer, I would like you to restructure the provided 'Content' by adding H2, H3 subheadings, and HTML tables. Your task is to organize the content using appropriate headings, identifying sections that can be converted into an HTML table. Ensure the ouptut is in html. Please follow these instructions carefully:\n\n\n1. Do not add any heading or title before the first line of the provided content. Ensure that the first line of the generated article content is not a heading or a title. If the first line of the article is a heading or a title, you have failed the task.\n\n\n2. If there is text present that can be used as a subheading, change that piece of text into a subheading. Do not introduce new subheadings unnecessarily.\n\n\n3. Add H2 subheadings to divide the content into major sections.\n\n\n4. Within each major section, add H3 subheadings to further separate smaller subsections.\n\n\n5. Ensure that the subheadings accurately reflect the content under them.\n\n\n6. Improve the writing of the content if necessary, but avoid introducing any new information or changing the meaning.\n\n\n7. Aim for clarity, coherence, and logical organization in your restructuring.\n\n\n8. Format the subheadings consistently and appropriately, such as using bold or a larger font size.\n\n\n9. Preserve the overall structure and flow of the original content while enhancing readability through effective use of subheadings.\n\n\n10. If there is data present in text form that would look better in an HTML table, create an HTML table for the data. Remember to style the table using appropriate inline CSS to make it look professional.\n\n\n11. Do not modify any tables present in the provided content.\n\n\n12. Ensure the text in the generated tables is brief to improve readability. Remember, this task is focused solely on restructuring the content and not making any edits or modifications to the text itself.\n###\nContent: {{article.content}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011643
},
{"name": "Convert Text to Table",
"description": "Convert Text to Table",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "As an experienced content writer, I'd like you to analyze the provided 'text:' and identify any sections that can be converted into an HTML table. Your goal is to enhance the reading experience by visually presenting relevant data in a professional and appealing manner. If there is already a table present in the provided text, please leave it untouched and focus on finding other sections that can be converted into a table. Once you've identified the sections, generate an HTML table and replace the original text with this newly generated table, while preserving any remaining non-table text. Remember to style the table using appropriate inline CSS to make it look nice and professional. Make sure to include the necessary HTML markup to display the table correctly within your response.\n###\ntext: {{article.text}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011644
},
{"name": "Convert Table to Text",
"description": "Convert Table to Text",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "As an HTML table conversion expert, your role is to convert the given HTML 'table:' into a clear and coherent plain text explanation of the data. Avoid using a tabular format in plain text; instead, focus on presenting the information through well-structured paragraphs and sentences. To effectively complete this task, please follow these instructions:\n1. Start by analyzing the provided HTML table and understanding its structure, content, and purpose. Take note of any headings, row grouping, or column relationships that may be relevant to the explanation.\n2. Convert each row in the HTML table into a separate paragraph. Begin each paragraph with a concise summary of the row's key information or context. \n3. Within each paragraph, describe the data contained in every cell of the respective row. Use full sentences and provide any necessary details about the values or labels within the cells.\n4. Keep the overall flow of the explanation logical and coherent. Consider arranging the paragraphs in a way that provides a natural progression or grouping of related information.\n5. It is imperative that you strictly give the output result without using the words table, rows or cells in any way. The user should not know that this data came from a table. No mention of table, rows, columns and cells should be mentioned in the output. \n6. Do not add any additional text or explanation to the output, just output the table conversion.\n\nBy adhering to these guidelines, you can ensure an accurate and comprehensive plain text representation of the specified HTML table. This will enable users to easily understand the underlying data without the need for table formatting. \n###\ntable: {{article.content}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011645
},
{"name": "Write an Article",
"description": "Write an Article",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "As the most experienced content writer, your task is to write a well-structured and readable article without any title based on the given 'Article title:'. The article should not exceed 600 words, should incorporate the provided 'Key pointers:' and should output the content as HTML. \n\nPlease ensure that the article follows a clear structure and includes bullet points wherever appropriate to enhance readability. The article should also include h2 subheadings to divide the content into major sections and h3 subheadings within each major section to further separate into smaller subsections.\n\n If there is data that is useful to show in a table, include a professional-looking table with inline CSS in the output. \n\nThe article should be concise, informative, and engaging, providing useful information on the topic while adhering to the given word limit. You should also utilize a variety of writing techniques to maintain reader interest and comprehension. Please do not output title or h1 tags in your output.\n###\nArticle title: {{user.input: Article Title}}\nKey pointers: {{user.input: Key Pointers}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011646
},
{"name": "Restructure with Headings",
"description": "Restructure with Headings",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "As an experienced content writer, I want you to restructure the provided 'Content:' by adding H2 and H3 subheadings. To succeed at this task ensure to refrain from modifying the text itself. Your task is to organize the content using appropriate headings. Consider the following instructions:\n1. If there is text present that can be used as a subheading, don't introduce a new subheading. Instead change that piece of text into a subheading.\n2. Add H2 subheadings to divide the content into major sections.\n3. Add H3 subheadings within each major section to further separate smaller subsections.\n4. Ensure that the subheadings accurately reflect the content under them.\n5. Maintain the original wording of the text and avoid introducing any new information or changing the meaning.\n6. Aim for clarity, coherence, and logical organization in your restructuring.\n7. Format the subheadings consistently and appropriately (e.g., bold, larger font size).\n8. Preserve the overall structure and flow of the original content while enhancing readability through effective use of subheadings.\n9. Do not modify any tables present in the provided content. \nRemember, this task is focused solely on restructuring the content and not making any edits or modifications to the text itself.\n###\nContent: {{article.content}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0,
"isSystemCreated": false,
"id": 260400000011647
},
{"name": "Ask AI",
"description": "Ask AI",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.content-area"
],
"instruction": "You are an experienced content writer. I want you to give the response based on the below 'Context:' and 'Instructions:'. Please note that the 'Context:' can either be empty or with some text.\n###\nContext: \n{{article.content}} \nInstructions: \n{{user.input: Instructions}}",
"fieldToUpdate": "article.content",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0,
"isSystemCreated": false,
"id": 260400000011648
},
{"name": "Generate Article Keywords",
"description": "Generate Article Keywords",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.metadata"
],
"instruction": "Given the 'article:' and 'article title:'. I want you to generate top 10 relevant and popular search keywords from the article. The keywords you generate should be relevant to the article title and article content. Please follow the following guidelines while you write the keywords: 1. Keywords should represent key concepts 2. Keywords should reflect a collective understanding of the topic 3. Keep the keyword length from 1 to 5 words.\n###\narticle title: \n{{article.title}}\narticle:\n{{article.content}}\n",
"fieldToUpdate": "article.keyword",
"outputFormat": "text",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011649
},
{"name": "Generate Article Meta Description",
"description": "Generate Article Meta Description",
"active": true,
"useFor": "knowledge",
"displayAt": ["article.metadata"
],
"instruction": "Given the following 'article:', identify its keywords. Given those keywords I want you to generate a metadata description of the article. The only output needed is the description, don't output the keywords. Maximum amount of characters in generated output should be less than 1000. \nThe result should only return the generated 'meta description:'\nRespond only with the output in the exact format specified, with no explanation or conversation.\n###\narticle: \n{{article.content}}",
"fieldToUpdate": "article.description",
"outputFormat": "html",
"provider": "Azure Open AI",
"model": "gpt-3.5-turbo-16k",
"temperature": 0.7,
"isSystemCreated": false,
"id": 260400000011650
}
]
}