aiQuestions.create
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
| Field | Type | Required | Notes |
|---|---|---|---|
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 | |
autoSenden | boolean | yes | |
fallVorlagen | object · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
aiQuestions.delete
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
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
| 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 | |
autoSenden | boolean | yes | |
fallVorlagen | object · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
aiQuestions.installDefaultPack
Install the 9-topic default seed pack on the current tenant. Idempotent. Mutation — changes data.
Input parameters
Returns object.
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | boolean | yes |
aiQuestions.list
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:
| 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 | |
autoSenden | boolean | yes | |
fallVorlagen | object · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
aiQuestions.setAutoSenden
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
an | 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 | |
autoSenden | boolean | yes | |
fallVorlagen | object · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
aiQuestions.setEnabled
Turns an FAQ topic (id) on or off via enabled without touching its texts. Owner only. Changes data. Mutation — changes data.
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 | |
autoSenden | boolean | yes | |
fallVorlagen | object · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |
aiQuestions.testMatch
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
| Field | Type | Required | Notes |
|---|---|---|---|
message | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
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
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
| Field | Type | Required | Notes |
|---|---|---|---|
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 | |
fallVorlagen | object · nullable | 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 | |
autoSenden | boolean | yes | |
fallVorlagen | object · nullable | yes | |
createdAt | string | yes | |
updatedAt | string | yes |