COSMO Bot - Connectors (2023)

  • Reference

COSMO Bot - Connectors (1)

COSMO Bot increases your business success through more efficiency in everyday life. If you answer a standard question today, you are wasting time. In contact with your customers, this is often a good opportunity to get to know each other and establish a relationship. But internally, from employee to employee, or when there is simply too much to do, it is a luxury that not everyone can allow themselves. This connector allows you to extend the bot's functionality and integrate other systems.

This connector is available in the following products and regions:

ServiceClassRegions
Logic AppsStandardAll Logic Apps regions except the following:
- Azure Government regions
- Azure China regions
- US Department of Defense (DoD)
Power AutomatePremiumAll Power Automate regions except the following:
- US Government (GCC)
- US Government (GCC High)
- China Cloud operated by 21Vianet
- US Department of Defense (DoD)
Power AppsPremiumAll Power Apps regions except the following:
- US Government (GCC)
- US Government (GCC High)
- China Cloud operated by 21Vianet
- US Department of Defense (DoD)
Contact
NameCOSMO CONSULT Support
URLhttps://de.cosmoconsult.com/service/support/
Emailsupport.west@cosmoconsult.com
Connector Metadata
PublisherCOSMO CONSULT GmbH
Websitehttps://cosma.link/cc-bot
Privacy policyhttps://www.cosmoconsult.com/data-protection/
CategoriesAI;Communication

Prerequisites

To use this connector you need to have administrative access to a COSMO Bot Instance. What is COSMO Bot? How do i get a COSMO Bot instance?

How to get credentials?

Once you have administrative access to a COSMO Bot Instance, go to the chat interface (i.e. https://cosma.cosmoconsult.com/) and switch to the "Administration" tab by clicking "Administration" in the top right corner. Navigate to "API Keys" and create a new one or copy an existing one.

Creating a connection

The connector supports the following authentication types:

DefaultParameters for creating connection.All regionsNot shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

NameTypeDescriptionRequired
Bot Instance URLstringThe URL where your bot instance can be reachedTrue
API KeysecurestringThe API key for accessing this bot instanceTrue

Throttling Limits

NameCallsRenewal Period
API calls per connection10060 seconds

Actions

Add a new question-answer set

Adds a new question-answer set to the connected instance.

Add a new topic

Adds a new topic to the connected instance.

Add an expert to a topic

The bot will add the expert to the provided topic.

Ask COSMO Bot a question

The bot will search through the knowledgebase and return the answer with the best match. Also returns the score.

Close a ticket

Closes an open ticket on the connected instance.

Convert COSMO Bot Script

Run the given text through the COSMO Bot Script parser.

Create a shadow copy of a question-answer set

Adds a new shadow copy for the question-answer set specified by the short description. Careful! These shadow copies are deleted when the answer is updated. It is therefore recommended to automatically call this action using the "when a question-answer set is updated" trigger.

Delete a question-answer set

Delete an existing question-answer set from the connected instance.

Edit an existing question-answer set

Edit an existing question-answer set from the connected instance.

Get all question-answer sets

Gets all answers from the connected instance.

Get all topics

Gets all topics from the connected bot instance.

Get experts for a topic

Gets all expoerts from the connected instance.

Get global settings

Gets the global settings from the connected instance.

Get open tickets

Gets all open tickets from the connected instance.

Get topic

Gets a specific topic from the connected instance.

Open a ticket (feedback)

Open a new ticket of type feedback on the connected instance.

Open a ticket (question)

Open a new ticket on the connected instance.

Remove an expert from a topic

The bot will remove an expert from the provided topic. If no topic is given, the expert will be removed from all topics.

Rename an existing topic

Rename a existing topic from the connected instance.

Translate (markdown friendly)

Translate the given text while respecting the COSMO Bot dialect Markdown syntax.

Add a new question-answer set

Operation ID:
AddAnswer

Adds a new question-answer set to the connected instance.

Parameters

NameKeyRequiredTypeDescription

Topic

topicTruestring

Short Description

shortDescriptionTruestring

Questions

Questionsstring

Answer Text

answerTextTruestring

User Email

userEmailstring

Add a new topic

Operation ID:
AddTopic

Adds a new topic to the connected instance.

Parameters

NameKeyRequiredTypeDescription

Topic Name

nameTruestring

Description

descriptionTruestring

Expert Emails

Expert Emailsstring

Add an expert to a topic

Operation ID:
AddExpert

The bot will add the expert to the provided topic.

Parameters

NameKeyRequiredTypeDescription

Topic

topicTruestring

Expert Email

expertEmailTruestring

Ask COSMO Bot a question

Operation ID:
AskQuestion

The bot will search through the knowledgebase and return the answer with the best match. Also returns the score.

Parameters

NameKeyRequiredTypeDescription

Question

questionTruestring

Score Threshold

scoreThresholdinteger

Minimum score of an answer for it to be returned.

User Email

userEmailstring

Returns

NamePathTypeDescription

Found Answer

foundAnswerboolean

Whether COSMO Bot found an answer that matched the question.

Is Shadow-Answer

isSubAnswerboolean

Whether the returned answer is a sub answer.

Was Question Translated

isTranslatedboolean

Whether the question and returned answer was translated.

Answer

answerAnswer

Score

scoreinteger

How confident the bot is that the returned answer is correct.

Close a ticket

Operation ID:
CloseTicket

Closes an open ticket on the connected instance.

Parameters

NameKeyRequiredTypeDescription

Unique Ticket ID

ticketIdTruestring

Email of the user that processed the ticket

editorEmailTruestring

Comment that will be sent to the user

editorCommentTruestring

Convert COSMO Bot Script

Operation ID:
ParseText

Run the given text through the COSMO Bot Script parser.

Parameters

NameKeyRequiredTypeDescription

Input Text

inputTextTruestring

Output Format

outputFormatTruestring

Returns

NamePathTypeDescription

Output Text

outputTextstring

The parsed text returned by the COSMO Bot Script Parser.

Create a shadow copy of a question-answer set

Operation ID:
AddSubAnswer

Adds a new shadow copy for the question-answer set specified by the short description. Careful! These shadow copies are deleted when the answer is updated. It is therefore recommended to automatically call this action using the "when a question-answer set is updated" trigger.

Parameters

NameKeyRequiredTypeDescription

Original Answer's Short Description

shortDescriptionTruestring

Shadow Copy's Short Description

subShortDescriptionTruestring

Questions

Questionsstring

Answer Text

subAnswerTextTruestring

Delete a question-answer set

Operation ID:
DeleteAnswer

Delete an existing question-answer set from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Short Description

shortDescriptionTruestring

Edit an existing question-answer set

Operation ID:
EditAnswer

Edit an existing question-answer set from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Short Description of the Existing Set

shortDescriptionTruestring

Updated Topic

newTopicstring

Updated Short Description

newShortDescriptionstring

Updated Questions

Updated Questionsstring

Updated Answer Text

newAnswerTextstring

User Email

userEmailstring

Get all question-answer sets

Operation ID:
GetAllAnswers

Gets all answers from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Filter by Topic (contains)

filterByTopicstring

Filter by Topic (contains)

Filter by Short Description (contains)

filterByShortDescriptionstring

Filter by Short Description (contains)

Filter by Question Text (contains)

filterByQuestionTextstring

Filter by Question Text (contains)

Filter by Answer Text (contains)

filterByAnswerTextstring

Filter by Answer Text (contains)

Returns

NamePathTypeDescription

Answers

answersarray of Answer

Get all topics

Operation ID:
GetAllTopics

Gets all topics from the connected bot instance.

Parameters

NameKeyRequiredTypeDescription

Filter by Expert

filterByExpertstring

Filter by Expert

Returns

NamePathTypeDescription

Topics

topicsarray of string

Get experts for a topic

Operation ID:
GetExperts

Gets all expoerts from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Topic

topicTruestring

Topic

Returns

NamePathTypeDescription

Experts

expertEmailsarray of string

Get global settings

Operation ID:
GetGlobalSettings

Gets the global settings from the connected instance.

Returns

The outputs of this operation are dynamic.

Get open tickets

Operation ID:
GetOpenTickets

Gets all open tickets from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Filter by Open Duration (minimum)

filterByHoursSinceOpenedinteger

Only get tickets that have been open for longer than x hours.

Filter by Open Duration (maximum)

filterByHoursSinceOpenedMaxinteger

Only get tickets that have been open for less than x hours.

Filter by Topic

filterByTopicstring

Filter by Topic

Filter by Expert

filterByExpertEmailstring

Filter by Expert

Returns

NamePathTypeDescription

Tickets

ticketsarray of Ticket

Get topic

Operation ID:
GetTopic

Gets a specific topic from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Topic Name

topicNameTruestring

Topic Name

Returns

NamePathTypeDescription

Name

topic.namestring

Description

topic.descriptionstring

Open a ticket (feedback)

Operation ID:
OpenTicketFeedback

Open a new ticket of type feedback on the connected instance.

Parameters

NameKeyRequiredTypeDescription

User Email

userEmailTruestring

Question that was asked by the user

queryTextTruestring

Short description of the answer

answerShortDescriptionTruestring

Feedback regarding the answer

feedbackTextTruestring

Returns

NamePathTypeDescription

Ticket

ticketTicket

Open a ticket (question)

Operation ID:
OpenTicketQuestion

Open a new ticket on the connected instance.

Parameters

NameKeyRequiredTypeDescription

User Email

userEmailTruestring

Question that was asked by the user

queryTextTruestring

Topic that this question likely belongs to

topicstring

Returns

NamePathTypeDescription

Ticket

ticketTicket

Remove an expert from a topic

Operation ID:
RemoveExpert

The bot will remove an expert from the provided topic. If no topic is given, the expert will be removed from all topics.

Parameters

NameKeyRequiredTypeDescription

Expert Email

expertEmailTruestring

Topic

topicstring

Rename an existing topic

Operation ID:
RenameTopic

Rename a existing topic from the connected instance.

Parameters

NameKeyRequiredTypeDescription

Topic Name

nameTruestring

The name of the existing topic to be renamed.

New Topic Name

newNameTruestring

The name that the topic will be renamed to.

Translate (markdown friendly)

Operation ID:
Translate

Translate the given text while respecting the COSMO Bot dialect Markdown syntax.

Parameters

NameKeyRequiredTypeDescription

Target Language

targetLanguageCodeTruestring

The target language code (example: fr).

Text

inputTextTruestring

The text to translate.

Returns

NamePathTypeDescription

Translated Text

outputTextstring

Triggers

When a new question-answer set is created

When a new question-answer set is created.

When a new ticket is created

When a new Ticket is created.

When a question-answer set is created or modified

When a question-answer set is created or modified.

When a ticket's topic is updated

When a topic of an existing Ticket is updated.

When a ticket is resolved

When a existing Ticket is resolved.

When a user asks a question

When a user asks a question.

When a new question-answer set is created

Operation ID:
OnNewAnswer

When a new question-answer set is created.

Returns

NamePathTypeDescription

Answer

answerAnswer

When a new ticket is created

Operation ID:
OnNewTicket

When a new Ticket is created.

Returns

NamePathTypeDescription

Ticket

ticketTicket

When a question-answer set is created or modified

Operation ID:
OnUpdateAnswer

When a question-answer set is created or modified.

Returns

NamePathTypeDescription

Answer

answerAnswer

When a ticket's topic is updated

Operation ID:
OnUpdatedTicketTopic

When a topic of an existing Ticket is updated.

Returns

NamePathTypeDescription

Ticket

ticketTicket

When a ticket is resolved

Operation ID:
OnResolvedTicket

When a existing Ticket is resolved.

Returns

NamePathTypeDescription

Ticket

ticketTicket

Editor Email

editorEmailstring

Editor Comment

editorCommentstring

Deep link to original query

queryUrlstring

When a user asks a question

Operation ID:
OnAskedQuestion

When a user asks a question.

Returns

NamePathTypeDescription

User Email

userEmailstring

Question that was asked by the user

queryTextstring

Found Answer

foundAnswerboolean

Whether COSMO Bot found an answer that matched the user's question.

Answer

answerAnswer

Definitions

Answer

NamePathTypeDescription

Topic

topicstring

Short Description

shortDescriptionstring

Questions

questionsarray of string

Answer Text

answerTextstring

Date and time that this answer was last modified at

modifiedAtdate-time

Modified by

modifiedBystring

Ticket

NamePathTypeDescription

Unique Ticket ID

ticketIdstring

Topic

topicstring

Deep link to process the ticket

ticketUrlstring

Requester Email

requesterEmailstring

Expert Emails

expertEmailsarray of string

Question that was asked by the user

queryTextstring

Feedback that was submitted by the user

feedbackTextstring

This is empty if this ticket is not feedback.

Short description of the answer that the user received after asking their question

answerShortDescriptionstring

This is empty if this ticket is not feedback.

Answer that the user received after asking their question

answerTextstring

This is empty if this ticket is not feedback.

Date and time that the ticket was created at

createdAtdate-time
Top Articles
Latest Posts
Article information

Author: Pres. Lawanda Wiegand

Last Updated: 11/20/2022

Views: 5702

Rating: 4 / 5 (51 voted)

Reviews: 82% of readers found this page helpful

Author information

Name: Pres. Lawanda Wiegand

Birthday: 1993-01-10

Address: Suite 391 6963 Ullrich Shore, Bellefort, WI 01350-7893

Phone: +6806610432415

Job: Dynamic Manufacturing Assistant

Hobby: amateur radio, Taekwondo, Wood carving, Parkour, Skateboarding, Running, Rafting

Introduction: My name is Pres. Lawanda Wiegand, I am a inquisitive, helpful, glamorous, cheerful, open, clever, innocent person who loves writing and wants to share my knowledge and understanding with you.