Skip to content

AiConnect.json

Cautions

When changing parameters, please refer to "Confirmation When Changing Parameters".

Setting Values

Top-Level Parameters

Parameter name e.g. Description
ProviderEndpoints { "Dify": "https://dify.example.com/v1", "OpenAi": "https://api.openai.com/v1" } The connection URL for each integration method. It is displayed in Endpoint of the integration setting template, and the value of this parameter is used when Endpoint is blank. If you enter a value in an invalid format in Endpoint, it is not switched to the value of ProviderEndpoints and an error occurs during integration.
AllowInsecureLoopbackEndpoint false Specify whether to allow HTTP connections to loopback addresses (localhost, 127.0.0.1, [::1]). The default value is false.
Rag See below Configures the settings of the RAG function other than the connection URL for each integration method.

Parameters Under Rag

Parameter name e.g. Description
Enabled true Switches the whole "RAG integration" between enabled and disabled.
DeleteEnabled true Switches deletion integration between enabled and disabled.
FormatTemplate ["# [Title]", "", "[Body]"] The initial value displayed in the "Integration Format" field when creating a new integration setting. Specify it as an array of strings. Each element is joined with a line break. For the default value, see "The Default Values of This Parameter File" below. Changing this value does not change the "Integration Format" of AI integration settings that are already registered.
OutputFilePath C:\Pleasanter\AiConnect Specify the root folder to which integration documents (.md files) are output. If you specify a relative path, the execution folder of Pleasanter is used as the base. Subfolders named after the tenant ID and the site ID are created under this folder. The execution user of Pleasanter needs write permission for this folder. If it cannot write, the output of the integration document fails and registration to the integration destination is not performed. Set the access permissions appropriately because data including the content of records is stored.
LogSucceeded true Specify whether to output a message to the system log when registration to the integration destination succeeds. This prevents excessive system log output when integrating a large number of records.
SyncRetryCount 2 The maximum number of retries when registration to the integration destination fails due to a communication error. If you specify 0, it does not retry. In addition, when the integration method is OpenAI and neither Endpoint of the integration setting nor OpenAi of ProviderEndpoints is set, it results in a setting error without communicating, and does not retry.
IndexCheckMaxAttempts 10 The maximum number of times to check the registration status when the integration method is "OpenAI". If you specify 0, it does not check the registration.
DeleteRetryCount 2 The maximum number of retries when deletion of a document at the integration destination fails due to a communication error, or when deletion of a ".md" file on the server fails temporarily. If you specify 0, it does not retry the deletion.
RetryAfterMaxSeconds 60 The maximum number of seconds to wait according to Retry-After of the response when the integration destination returns a rate limit (HTTP status 429). The default value is 60.

The Default Values of This Parameter File

{
    "ProviderEndpoints": {
        "Dify": "",
        "OpenAi": ""
    },
    "AllowInsecureLoopbackEndpoint": false,
    "Rag": {
        "Enabled": false,
        "DeleteEnabled": false,
        "FormatTemplate": [
            "# [Title]",
            "",
            "| 項目 | 値 |",
            "|------|----|",
            "| 状況 | [Status] |",
            "| 管理者 | [Manager] |",
            "| 担当者 | [Owner] |",
            "| 作成者 | [Creator] |",
            "| 更新者 | [Updator] |",
            "| 更新日時 | [UpdatedTime] |",
            "",
            "## 内容",
            "",
            "[Body]",
            "",
            "## コメント",
            "",
            "[Comments]",
            "",
            "---",
            "",
            "URL: {Url}",
            ""
        ],
        "OutputFilePath": null,
        "LogSucceeded": true,
        "SyncRetryCount": 2,
        "IndexCheckMaxAttempts": 10,
        "DeleteRetryCount": 2,
        "RetryAfterMaxSeconds": 60
    }
}

Supported Versions

Supported versions Body
1.5.8.0 and later Added AiConnect.json