FoyerDevelopers

Generated · Live registry

aiQuestions tools

9 tools in this domain, generated from the running registry.

All tool domains

aiQuestions.create

writes

Creates a new FAQ topic (name, topic, optional trigger phrases, default answer, translations, threshold, enabled) used to recognize and answer incoming guest questions. Owner only. Changes data; a topic that already exists results in CONFLICT. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
namestringyes
topicstringyes
descriptionstringno
triggerPhrasesarray of stringno
defaultResponsestringno
responseTranslationsobjectno
confidenceThresholdnumberno
enabledbooleanno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
topicstringyes
descriptionstring · nullableyes
triggerPhrasesarray of stringyes
defaultResponsestring · nullableyes
responseTranslationsobjectyes
confidenceThresholdstringyesDecimal as string — numeric column, not an IEEE-754 double
enabledbooleanyes
detectionCountintegeryes
falsePositiveCountintegeryes
lastMatchedAtstring · nullableyes
embeddingarray of number · nullableyes
embeddingModelstring · nullableyes
isInvoicebooleanyes
autoSendenbooleanyes
fallVorlagenobject · nullableyes
createdAtstringyes
updatedAtstringyes

aiQuestions.delete

writesconfirm

Delete a custom AI question/FAQ entry.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
okbooleanyes

aiQuestions.get

read-only

Returns an FAQ topic by its id (trigger phrases, default answer, translations, threshold, enabled). Any signed-in role. Read-only; an unknown id results in NOT_FOUND.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
topicstringyes
descriptionstring · nullableyes
triggerPhrasesarray of stringyes
defaultResponsestring · nullableyes
responseTranslationsobjectyes
confidenceThresholdstringyesDecimal as string — numeric column, not an IEEE-754 double
enabledbooleanyes
detectionCountintegeryes
falsePositiveCountintegeryes
lastMatchedAtstring · nullableyes
embeddingarray of number · nullableyes
embeddingModelstring · nullableyes
isInvoicebooleanyes
autoSendenbooleanyes
fallVorlagenobject · nullableyes
createdAtstringyes
updatedAtstringyes

aiQuestions.installDefaultPack

writes

Install the 9-topic default seed pack on the current tenant. Idempotent. Mutation — changes data.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
okbooleanyes

aiQuestions.list

read-only

Lists all FAQ topics of the property (trigger phrases, default answer, translations, threshold, enabled/auto-send), sorted by topic. Any signed-in role. Read-only.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
topicstringyes
descriptionstring · nullableyes
triggerPhrasesarray of stringyes
defaultResponsestring · nullableyes
responseTranslationsobjectyes
confidenceThresholdstringyesDecimal as string — numeric column, not an IEEE-754 double
enabledbooleanyes
detectionCountintegeryes
falsePositiveCountintegeryes
lastMatchedAtstring · nullableyes
embeddingarray of number · nullableyes
embeddingModelstring · nullableyes
isInvoicebooleanyes
autoSendenbooleanyes
fallVorlagenobject · nullableyes
createdAtstringyes
updatedAtstringyes

aiQuestions.setAutoSenden

writes

Sends the answer to this question automatically: after 10–30 s, once per booking, only if the message really asks only this question. Owner only — from then on Foyer writes to guests in the owner's name without anyone reviewing it. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
anbooleanyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
topicstringyes
descriptionstring · nullableyes
triggerPhrasesarray of stringyes
defaultResponsestring · nullableyes
responseTranslationsobjectyes
confidenceThresholdstringyesDecimal as string — numeric column, not an IEEE-754 double
enabledbooleanyes
detectionCountintegeryes
falsePositiveCountintegeryes
lastMatchedAtstring · nullableyes
embeddingarray of number · nullableyes
embeddingModelstring · nullableyes
isInvoicebooleanyes
autoSendenbooleanyes
fallVorlagenobject · nullableyes
createdAtstringyes
updatedAtstringyes

aiQuestions.setEnabled

writes

Turns an FAQ topic (id) on or off via enabled without touching its texts. Owner only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
enabledbooleanyes

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
topicstringyes
descriptionstring · nullableyes
triggerPhrasesarray of stringyes
defaultResponsestring · nullableyes
responseTranslationsobjectyes
confidenceThresholdstringyesDecimal as string — numeric column, not an IEEE-754 double
enabledbooleanyes
detectionCountintegeryes
falsePositiveCountintegeryes
lastMatchedAtstring · nullableyes
embeddingarray of number · nullableyes
embeddingModelstring · nullableyes
isInvoicebooleanyes
autoSendenbooleanyes
fallVorlagenobject · nullableyes
createdAtstringyes
updatedAtstringyes

aiQuestions.testMatch

read-only

Run the classifier locally against a typed test message, return the match preview. Does NOT send anything — read-only side-effect-free. Used by the editor's "Test" button so operators can sanity-check a topic before activating it.

Input parameters

FieldTypeRequiredNotes
messagestringyes

Output fields

FieldTypeRequiredNotes
matchedbooleanyes
topicstring · nullableyes
questionIdstring · nullableyes
matchedPhrasestring · nullableyes
confidencenumberyes
thresholdnumberyes
partialMatchesarray of objectyes
partialMatches.questionIdstringyes
partialMatches.topicstringyes
partialMatches.confidencenumberyes
partialMatches.matchedPhrasestringyes

aiQuestions.update

writes

Partially updates an existing FAQ topic (only the fields passed: name, topic, trigger phrases, default answer, translations, threshold, enabled) and refreshes its embedding. Owner only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
namestringno
topicstringno
descriptionstringno
triggerPhrasesarray of stringno
defaultResponsestringno
responseTranslationsobjectno
confidenceThresholdnumberno
enabledbooleanno
fallVorlagenobject · nullableno

Output fields

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
namestringyes
topicstringyes
descriptionstring · nullableyes
triggerPhrasesarray of stringyes
defaultResponsestring · nullableyes
responseTranslationsobjectyes
confidenceThresholdstringyesDecimal as string — numeric column, not an IEEE-754 double
enabledbooleanyes
detectionCountintegeryes
falsePositiveCountintegeryes
lastMatchedAtstring · nullableyes
embeddingarray of number · nullableyes
embeddingModelstring · nullableyes
isInvoicebooleanyes
autoSendenbooleanyes
fallVorlagenobject · nullableyes
createdAtstringyes
updatedAtstringyes