update configuration tables

ist-dresden · Oct 4, 2024 · 3751f2a · 3751f2a
1 parent 0969c8a
commit 3751f2a
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 46 deletions.
diff --git a/src/site/markdown/autogenerated/osgiconfigurations.md b/src/site/markdown/autogenerated/osgiconfigurations.md
@@ -21,16 +21,17 @@ Configuration for the Approximate Markdown Service used to get a text representa
 
 Configuration of the automatic translation of AEM pages. The OSGI configuration is only used if no Sling CAConfig configuration is found.
 
-| id                                   | name                                   | type    | default value | description                                                                                                                                                                                                                       |
-|----|------|------|---------------|-------------|
-| pocUiEnabled | Debugging UI | boolean | false | Enable the Autotranslate debugging UI at /apps/composum-ai/components/autotranslate/list/list.html , normally disabled. Only read from OSGI configuration. |
-| disabled | Disable | boolean | false | Disable the Autotranslate service |
-| deniedResourceTypes | Denied Resource Types | String[] |  | Regexes for denied Resource Types - if the sling:resourceType matches that, then no attributes or child nodes are touched by the automatic translation. |
-| allowedAttributeRegexes | Allowed Additional Attributes | String[] |  | Matches for Attributes that are explicitly allowed to be translated, in addition to standard attributes and heuristically recognized attributes. The heuristics is that the value has to have letters and whitespaces. Syntax: regular expressions that match resource type % attribute name - e.g. myapp/component/html%markup |
-| deniedAttributesRegexes | Denied Attributes | String[] |  | Attributes that are explicitly denied to be translated. Can be used to override the heuristics / standard attributes. Same syntax as allowed attributes. |
-| ignoreAssetsExceptContentFragments    | Ignore Assets except Content Fragments | boolean | true          | If true, assets are ignored for translation, except for content fragments. (Otherwise the translator would translate metadata of images and videos.)                                                                                |
-| useHighIntelligenceModel             | Use High Intelligence Model            | boolean | true          | If true, the translator will use the 'high-intelligence model' (see OpenAI config) for translation. Default: true.                                                                                                              |
-| includeAlreadyTranslatedValues        | Include Already Translated Values      | boolean | true          | If a page is re-translated with only a few modified texts: if set we include the unchanged texts that don't have to be translated again, too, as they are in the target language. This might guide the translation of the now (re-)translated properties. |
+| id                                      | name                                      | type    | default value | description                                                                                                                                                                                                                       |
+|-----------------------------------------|-------------------------------------------|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| pocUiEnabled                            | Debugging UI                             | boolean | false         | Enable the Autotranslate debugging UI at at /apps/composum-ai/components/autotranslate/list/list.html, normally disabled. Only read from OSGI configuration.                                                                     |
+| disabled                                | Disable                                  | boolean | false         | Disable the Autotranslate service.                                                                                                                                                                                              |
+| deniedResourceTypes                     | Denied Resource Types                    | String[]| []            | Regexes for denied Resource Types - if the sling:resourceType matches that, then no attributes or child nodes are touched by the automatic translation.                                                                          |
+| allowedAttributeRegexes                 | Allowed Additional Attributes             | String[]| []            | Matches for Attributes that are explicitly allowed to be translated, in addition to standard attributes and heuristically recognized attributes. The heuristics is that the value has to have letters and whitespaces. Syntax: regular expressions that match resource type % attribute name - e.g. myapp/component/html%markup |
+| deniedAttributesRegexes                 | Denied Attributes                        | String[]| []            | Attributes that are explicitly denied to be translated. Can be used to override the heuristics / standard attributes. Same syntax as allowed attributes.                                                                           |
+| ignoreAssetsExceptContentFragments      | Ignore Assets except Content Fragments    | boolean | true          | If true, assets are ignored for translation, except for content fragments. (Otherwise the translator would translate metadata of images and videos.)                                                                               |
+| useHighIntelligenceModel                | Use High Intelligence Model               | boolean | true          | If true, the translator will use the 'high-intelligence model' (see OpenAI config) for translation. Default: true.                                                                                                              |
+| includeFullPageInRetranslation          | Include Full Page during Retranslation    | boolean | true          | If true we do not only provide changed texts to the AI during re-translating a page with some changes, but give the entire page to provide better context. That is a bit slower and a bit more expensive, but likely improves the result. |
+| includeExistingTranslationsInRetranslation| Include Existing Translations in Retranslation| boolean | true          | If true, when retranslating a page with some changes we provide the existing translations of that page to the AI as well as additional context with examples. That is a bit slower and a bit more expensive, but likely improves the result. |
 
 <a name="osgi.GPTChatCompletionServiceImpl"></a>
 ## Composum AI OpenAI Configuration (backend/base)
@@ -111,13 +112,13 @@ If configured, Sling Context Aware Configuration takes precedence over OSGI conf
 
 Configuration for the basic Composum AI Translation Service
 
-| id              | name                          | type    | default value | description                                                                                                                                                                                                                     |
+| id            | name                          | type    | default value | description                                                                                                                                                                                                                                           |
 |----|------|------|---------------|-------------|
 | disabled | Disable the translation service | boolean | false | Disable the translation service |
-| fakeTranslation  | Fake translation               | boolean | false         | For quick and inexpensive testing, when you just want to check that the translation does something for e.g. a bulk of texts, you can enable this. The "translation" then just turns the text iNtO tHiS cApItAlIsAtIoN. Easy to spot, but probably doesn't destroy the content completely. |
-| diskCache       | Disk cache                    | String  | ""            | Path to a directory where to cache the translations. If empty, no caching is done. If the path is relative, it is relative to the current working directory. If the path is absolute, it is used as is.                        |
-| temperature     | temperature                   | String  | ""            | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.                                                    |
-| seed            | seed                          | String  | ""            | If specified, OpenAI will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.                                                            |
+| fakeTranslation | Fake translation              | boolean | false         | For quick and inexpensive testing, when you just want to check that the translation does something for e.g. a bulk of texts, you can enable this. The "translation" then just turns the text iNtO tHiS cApItAlIsAtIoN. Easy to spot, but probably doesn't destroy the content completely. |
+| diskCache     | Disk cache                    | String  | ""            | Path to a directory where to cache the translations. If empty, no caching is done. If the path is relative, it is relative to the current working directory. If the path is absolute, it is used as is.                                          |
+| temperature   | temperature                   | String  | ""            | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.                                                                          |
+| seed          | seed                          | String  | ""            | If specified, OpenAI will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result.                                                                                 |
 
 <a name="osgi.HtmlToApproximateMarkdownServicePlugin"></a>
 ## Composum AI Html To Approximate Markdown Service Plugin (slingbase)

diff --git a/src/site/markdown/autogenerated/parts/osgi.AutoTranslateConfig.md.part b/src/site/markdown/autogenerated/parts/osgi.AutoTranslateConfig.md.part
@@ -1,16 +1,17 @@
-/* AIGenVersion(5a369cc2, osgiconfigurations.prompt-1.1, AutoTranslateConfig.java-1f8eea62) */
+/* AIGenVersion(081c74ae, osgiconfigurations.prompt-1.1, AutoTranslateConfig.java-0faaecc5) */
 
 ## Composum AI Autotranslate Configuration (aem/core)
 
 Configuration of the automatic translation of AEM pages. The OSGI configuration is only used if no Sling CAConfig configuration is found.
 
-| id                                   | name                                   | type    | default value | description                                                                                                                                                                                                                       |
-|----|------|------|---------------|-------------|
-| pocUiEnabled | Debugging UI | boolean | false | Enable the Autotranslate debugging UI at /apps/composum-ai/components/autotranslate/list/list.html , normally disabled. Only read from OSGI configuration. |
-| disabled | Disable | boolean | false | Disable the Autotranslate service |
-| deniedResourceTypes | Denied Resource Types | String[] |  | Regexes for denied Resource Types - if the sling:resourceType matches that, then no attributes or child nodes are touched by the automatic translation. |
-| allowedAttributeRegexes | Allowed Additional Attributes | String[] |  | Matches for Attributes that are explicitly allowed to be translated, in addition to standard attributes and heuristically recognized attributes. The heuristics is that the value has to have letters and whitespaces. Syntax: regular expressions that match resource type % attribute name - e.g. myapp/component/html%markup |
-| deniedAttributesRegexes | Denied Attributes | String[] |  | Attributes that are explicitly denied to be translated. Can be used to override the heuristics / standard attributes. Same syntax as allowed attributes. |
-| ignoreAssetsExceptContentFragments    | Ignore Assets except Content Fragments | boolean | true          | If true, assets are ignored for translation, except for content fragments. (Otherwise the translator would translate metadata of images and videos.)                                                                                |
-| useHighIntelligenceModel             | Use High Intelligence Model            | boolean | true          | If true, the translator will use the 'high-intelligence model' (see OpenAI config) for translation. Default: true.                                                                                                              |
-| includeAlreadyTranslatedValues        | Include Already Translated Values      | boolean | true          | If a page is re-translated with only a few modified texts: if set we include the unchanged texts that don't have to be translated again, too, as they are in the target language. This might guide the translation of the now (re-)translated properties. |
+| id                                      | name                                      | type    | default value | description                                                                                                                                                                                                                       |
+|-----------------------------------------|-------------------------------------------|---------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| pocUiEnabled                            | Debugging UI                             | boolean | false         | Enable the Autotranslate debugging UI at at /apps/composum-ai/components/autotranslate/list/list.html, normally disabled. Only read from OSGI configuration.                                                                     |
+| disabled                                | Disable                                  | boolean | false         | Disable the Autotranslate service.                                                                                                                                                                                              |
+| deniedResourceTypes                     | Denied Resource Types                    | String[]| []            | Regexes for denied Resource Types - if the sling:resourceType matches that, then no attributes or child nodes are touched by the automatic translation.                                                                          |
+| allowedAttributeRegexes                 | Allowed Additional Attributes             | String[]| []            | Matches for Attributes that are explicitly allowed to be translated, in addition to standard attributes and heuristically recognized attributes. The heuristics is that the value has to have letters and whitespaces. Syntax: regular expressions that match resource type % attribute name - e.g. myapp/component/html%markup |
+| deniedAttributesRegexes                 | Denied Attributes                        | String[]| []            | Attributes that are explicitly denied to be translated. Can be used to override the heuristics / standard attributes. Same syntax as allowed attributes.                                                                           |
+| ignoreAssetsExceptContentFragments      | Ignore Assets except Content Fragments    | boolean | true          | If true, assets are ignored for translation, except for content fragments. (Otherwise the translator would translate metadata of images and videos.)                                                                               |
+| useHighIntelligenceModel                | Use High Intelligence Model               | boolean | true          | If true, the translator will use the 'high-intelligence model' (see OpenAI config) for translation. Default: true.                                                                                                              |
+| includeFullPageInRetranslation          | Include Full Page during Retranslation    | boolean | true          | If true we do not only provide changed texts to the AI during re-translating a page with some changes, but give the entire page to provide better context. That is a bit slower and a bit more expensive, but likely improves the result. |
+| includeExistingTranslationsInRetranslation| Include Existing Translations in Retranslation| boolean | true          | If true, when retranslating a page with some changes we provide the existing translations of that page to the AI as well as additional context with examples. That is a bit slower and a bit more expensive, but likely improves the result. |