aiQuestions tools · Foyer Connect

`aiQuestions.create`

writes

Ai questions: create. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`name`	string	yes
`topic`	string	yes
`description`	string	no
`triggerPhrases`	array of string	no
`defaultResponse`	string	no
`responseTranslations`	object	no
`confidenceThreshold`	number	no
`enabled`	boolean	no

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`name`	string	yes
`topic`	string	yes
`description`	string · nullable	yes
`triggerPhrases`	array of string	yes
`defaultResponse`	string · nullable	yes
`responseTranslations`	object	yes
`confidenceThreshold`	string	yes	Decimal as string — numeric column, not an IEEE-754 double
`enabled`	boolean	yes
`detectionCount`	integer	yes
`falsePositiveCount`	integer	yes
`lastMatchedAt`	string · nullable	yes
`embedding`	array of number · nullable	yes
`embeddingModel`	string · nullable	yes
`isInvoice`	boolean	yes
`createdAt`	string	yes
`updatedAt`	string	yes

`aiQuestions.delete`

writesconfirm

Delete a custom AI question/FAQ entry.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`ok`	boolean	yes

`aiQuestions.get`

read-only

Ai questions: get. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`name`	string	yes
`topic`	string	yes
`description`	string · nullable	yes
`triggerPhrases`	array of string	yes
`defaultResponse`	string · nullable	yes
`responseTranslations`	object	yes
`confidenceThreshold`	string	yes	Decimal as string — numeric column, not an IEEE-754 double
`enabled`	boolean	yes
`detectionCount`	integer	yes
`falsePositiveCount`	integer	yes
`lastMatchedAt`	string · nullable	yes
`embedding`	array of number · nullable	yes
`embeddingModel`	string · nullable	yes
`isInvoice`	boolean	yes
`createdAt`	string	yes
`updatedAt`	string	yes

`aiQuestions.installDefaultPack`

writes

Ai questions: install default pack. Mutation — changes data. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Field	Type	Required	Notes
`ok`	boolean	yes

`aiQuestions.list`

read-only

Ai questions: list. Read-only query. See the input schema for argument details.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`name`	string	yes
`topic`	string	yes
`description`	string · nullable	yes
`triggerPhrases`	array of string	yes
`defaultResponse`	string · nullable	yes
`responseTranslations`	object	yes
`confidenceThreshold`	string	yes	Decimal as string — numeric column, not an IEEE-754 double
`enabled`	boolean	yes
`detectionCount`	integer	yes
`falsePositiveCount`	integer	yes
`lastMatchedAt`	string · nullable	yes
`embedding`	array of number · nullable	yes
`embeddingModel`	string · nullable	yes
`isInvoice`	boolean	yes
`createdAt`	string	yes
`updatedAt`	string	yes

`aiQuestions.setEnabled`

writes

Ai questions: set enabled. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`id`	string	yes
`enabled`	boolean	yes

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`name`	string	yes
`topic`	string	yes
`description`	string · nullable	yes
`triggerPhrases`	array of string	yes
`defaultResponse`	string · nullable	yes
`responseTranslations`	object	yes
`confidenceThreshold`	string	yes	Decimal as string — numeric column, not an IEEE-754 double
`enabled`	boolean	yes
`detectionCount`	integer	yes
`falsePositiveCount`	integer	yes
`lastMatchedAt`	string · nullable	yes
`embedding`	array of number · nullable	yes
`embeddingModel`	string · nullable	yes
`isInvoice`	boolean	yes
`createdAt`	string	yes
`updatedAt`	string	yes

`aiQuestions.testMatch`

read-only

Ai questions: test match. Read-only query. See the input schema for argument details.

Input parameters

Field	Type	Required	Notes
`message`	string	yes

Output fields

Field	Type	Required
`matched`	boolean	yes
`topic`	string · nullable	yes
`questionId`	string · nullable	yes
`matchedPhrase`	string · nullable	yes
`confidence`	number	yes
`threshold`	number	yes
`partialMatches`	array of object	yes
`partialMatches.questionId`	string	yes
`partialMatches.topic`	string	yes
`partialMatches.confidence`	number	yes
`partialMatches.matchedPhrase`	string	yes

`aiQuestions.update`

writes

Ai questions: update. Mutation — changes data. See the input schema for argument details.

Input parameters

Field	Type	Required
`id`	string	yes
`name`	string	no
`topic`	string	no
`description`	string	no
`triggerPhrases`	array of string	no
`defaultResponse`	string	no
`responseTranslations`	object	no
`confidenceThreshold`	number	no
`enabled`	boolean	no

Output fields

Field	Type	Required	Notes
`id`	string	yes
`tenantId`	string	yes
`name`	string	yes
`topic`	string	yes
`description`	string · nullable	yes
`triggerPhrases`	array of string	yes
`defaultResponse`	string · nullable	yes
`responseTranslations`	object	yes
`confidenceThreshold`	string	yes	Decimal as string — numeric column, not an IEEE-754 double
`enabled`	boolean	yes
`detectionCount`	integer	yes
`falsePositiveCount`	integer	yes
`lastMatchedAt`	string · nullable	yes
`embedding`	array of number · nullable	yes
`embeddingModel`	string · nullable	yes
`isInvoice`	boolean	yes
`createdAt`	string	yes
`updatedAt`	string	yes