Columns that the Agent can use to search for the record of interest. Leave empty to use all columns of the dataset

Columns that will be returned to the Agent. Leave empty to use all columns of the dataset

Max records

This should usually be kept to a very low number (< 10)

LLM / Agent

Forward context

<span class="help-inline"> System prompt that will be prepended to the LLM / Agent invocation </span> </div> </div> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> <div ng-if="activeLLM"> <form class="dkuform-horizontal"> <h4 class="settings-section-title">Completion settings</h4> <prompt-llm-completion-settings completion-settings="agentTool.params.completionSettings" active-llm="activeLLM"></prompt-llm-completion-settings> </form> </div> </form> </div> <div ng-if="agentTool.type == 'DatasetRowAppend'"> <form class="dkuform-horizontal"> <div class="control-group"> <label class="control-label"> Dataset </label> <div class="controls"> <div class="tool-agent--dataset-selector" dataset-selector="agentTool.params.datasetRef" on-dataset-selector-change="updateInputDatasetColumns()" popover-placement="right" available-datasets="availableDatasets"></div> </div> </div> <div class="control-group"> <label class="control-label"> Restrict to columns </label> <div class="controls"> <basic-select items="datasetColumns" searchable="true" actions-box="true" placeholder="Select columns" ng-model="agentTool.params.restrictColumns" multiple="true" /> <span class="help-inline"> Columns that the Agent can write. Leave empty to allow all columns of the dataset </span> </div> </div> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type == 'VectorStoreSearch'"> <form class="dkuform-horizontal mbot24"> <div class="control-group"> <label class="control-label"> Knowledge Bank </label> <div class="controls"> <div knowledge-bank-selector="agentTool.params.knowledgeBankRef" available-knowledge-banks="availableKnowledgeBanks" popover-placement="auto"></div> </div> </div> <div class="control-group"> <label for="kbDocumentLevelSecurity" class="control-label"> Enforce document-level security </label> <div class="controls"> <input id="kbDocumentLevelSecurity" type="checkbox" ng-model="agentTool.params.enforceDocumentLevelSecurity" ng-disabled="knowledgeBank && knowledgeBank.vectorStoreType == 'VERTEX_AI_GCS_BASED'" /> <span class="help-inline" ng-if="knowledgeBank && knowledgeBank.vectorStoreType == 'VERTEX_AI_GCS_BASED'"> The VertexAI vector store doesn't support document-level security. </span> </div> </div> <div class="alert alert-warning horizontal-flex" ng-if="embeddingRecipeDesc && !embeddingRecipeDesc.securityTokensColumn && agentTool.params.enforceDocumentLevelSecurity"> <div class="padright16"><i class="icon-dku-warning" /></div> <div>To use this property, please select a Security tokens column in the Embedding Recipe <a ng-if="getParentRecipeHref()" href="{{getParentRecipeHref()}}" target="_blank"> {{rkFullInfo.creatingRecipe.name}}</a> advanced properties.</div> </div> <h2 class="settings-section-title">Retrieval</h2> <div class="control-group mtop24"> <label class="control-label"> Columns to retrieve </label> <div class="controls"> <basic-select searchable="true" actions-box="true" multiple="true" placeholder="Select columns" ng-model="agentTool.params.retrievalColumns" bind-value="value" bind-label="label" bind-disabled="disabled" ng-change="ensureEmbeddingStaysSelected()" items="retrievalColumnsOptions"></basic-select> <div class="help-inline"> Columns to pass as context to the LLM. </div> </div> </div> <div> <retrieval-params-settings ng-if="knowledgeBank" llm-exposed-with="agentTool.params" retrievable-knowledge="knowledgeBank" show-document-cost-warning="true" embedding-recipe-desc="embeddingRecipeDesc"/> </div> <h2 ng-if="agentTool.params && agentTool.params.sourcesSettings && knowledgeBankSchemaColumnNames.length" class="settings-section-title">Sources</h2> <additional-info-sources-formatting-config ng-if="agentTool.params && agentTool.params.sourcesSettings && knowledgeBankSchemaColumnNames.length" model="agentTool.params.sourcesSettings" metadata-columns="knowledgeBankSchemaColumnNames"> </additional-info-sources-formatting-config> <h2 class="settings-section-title">Filtering</h2> <vector-store-filter ng-if="knowledgeBank && agentTool" knowledge-bank="knowledgeBank" filter="agentTool.params.filter" perform-filtering="agentTool.params.performFiltering"></vector-store-filter> <div class="control-group"> <label for="allowDynamicFiltering" class="control-label"> Enable dynamic filtering </label> <div class="controls"> <input id="allowDynamicFiltering" type="checkbox" ng-model="agentTool.params.allowDynamicFiltering" /> <span class="help-inline"> If enabled, query level filtering will be supported </span> </div> </div> <div class="control-group"> <label for="allowAgentInferredFiltering" class="control-label"> Enable agent-inferred filtering </label> <div class="controls"> <input id="allowAgentInferredFiltering" type="checkbox" ng-model="agentTool.params.allowAgentInferredFiltering" /> <span class="help-inline"> If enabled, the agent can automatically define dynamic filters using the configured filterable columns </span> </div> <div class="controls mtop8" ng-if="knowledgeBankSchemaColumnNames.length"> <editable-list ng-model="agentTool.params.columnsDescriptions" add-label="Add column" ng-if="agentTool.params.allowAgentInferredFiltering" full-width-list="true" on-change="onColumnsDescriptionChange" transcope="{ knowledgeBankSchemaColumnNames: knowledgeBankSchemaColumnNames }" > <ng2-typeahead class="w50" [(value)]="it.name" [suggestions]="knowledgeBankSchemaColumnNames" [required]="true" no-match-tooltip="Column not in metadata columns" placeholder="Select metadata column"> </ng2-typeahead> <div class="editable-list__noflex editable-list__icon"> <i class="editable-list__arrow-icon dku-icon-arrow-right-long-16"></i> </div> <textarea class="editable-list__noflex w100" ng-model="it.description" placeholder="Column description" /> </editable-list> <div class="alert alert-warning mtop8 mbot0 horizontal-flex" ng-if="duplicatedMetadataDescriptions.length"> <div class="padright8"><i class="dku-icon-warning-fill-16"></i></div> <span> The following column{{duplicatedMetadataDescriptions.length > 1? 's are': ' is'}} declared more than once:<strong> {{duplicatedMetadataDescriptions.join(', ')}}</strong> </span> </div> </div> </div> <h2 class="settings-section-title">Tool description</h2> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type.indexOf('Custom') == 0"> <div plugin-settings-alert plugin-desc="pluginDesc" component-type="agent tool" has-settings="pluginDesc.hasSettings" app-config="appConfig" /> <div custom-params-form desc="customAgentToolDesc.desc" plugin-desc="pluginDesc" component-id="customAgentToolDesc.id" config="agentTool.params.config" /> <form class="dkuform-horizontal"> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type == 'ClassicalPredictionModelPredict'"> <form class="dkuform-horizontal"> <div class="control-group"> <label class="control-label"> Saved model </label> <div class="controls"> <basic-select ng-if="availableSavedModels" items="availableSavedModels" ng-model="agentTool.params.smRef" bind-value="ref" bind-label="name" searchable="true" invalidate-on-ghosts="true" ghost-items-tooltip="Saved Model not available. It has been disabled, retired, or is not supported for this feature. Choose another Saved Model or contact your administrator."></basic-select> <div class="mbot0 mtop8 alert alert-warning" ng-if="agentTool.params.smRef && (availableSavedModels | filter:{ref: agentTool.params.smRef}:true).length === 0"> Saved Model not available. It has been disabled, retired, or is not supported for this feature. Choose another Saved Model or contact your administrator. </div> </div> </div> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type == 'GRELCalculator'"> <form class="dkuform-horizontal"> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type == 'DataikuReporter'"> <h3 class="settings-section-title">Channel settings</h3> <form class="dkuform-horizontal"> <div class="control-group"> <label class="control-label"> Integration type </label> <div class="controls"> <select ng-model="agentTool.params.integration.type" ng-options="type.id as type.label for type in integrationTypes" /> </div> </div> <div ng-if="agentTool.params.integration.type" tool-integration-params hook="agentTool.params.integration" /> </form> <h3 class="settings-section-title">Variables</h3> <div class="alert alert-warning mbot0" ng-if="undefinedTemplateVariables.length || hasUnusedVariable()"> <div ng-if="undefinedTemplateVariables.length == 1">Variable <em>{{ undefinedTemplateVariables[0] }}</em> is used but not defined below. <a ng-click="addUndefinedVariables()">Add it to the list</a>.</div> <div ng-if="undefinedTemplateVariables.length > 1">{{ undefinedTemplateVariables.length }} variables are used but not defined below. <a ng-click="addUndefinedVariables()">Add them to the list</a>.</div> <div ng-if="unusedToolVariables.length == 1">Variable <em>{{ unusedToolVariables[0] }}</em> is not used. <a ng-click="removeUnusedVariables()">Remove it from the list</a>.</div> <div ng-if="unusedToolVariables.length > 1">{{ unusedToolVariables.length }} variables are not used. <a ng-click="removeUnusedVariables()">Remove them from the list</a>.</div> </div> <p>Available variables to customize the message to be sent (content, recipients etc.). Can be used in the template with <em>${variable}</em> syntax.</p> <div add-remove ng-model="agentTool.params.variables"> <editable-list ng-model="agentTool.params.variables" sortable="true" template="{sourceType: 'TOOL_INPUT'}" add-label="Add a variable" on-change="variableChanged" class="tool-agent--variable-list" transcope="{editFormula: editFormula, dssVariablesOptions: dssVariablesOptions, variableTypes: variableTypes, isUnused: isUnusedVariable, hasUnusedVariable: hasUnusedVariable}"> <span style="width:16px" ng-if="hasUnusedVariable()"> <span ng-if="isUnused(it.id)"> <i class="dku-icon-warning-outline-16 text-warning" toggle="tooltip-right" title="This variable is not used in any template field."></i> </span> </span> <editable-list-input type="text" ng-model="it.id" unique="true" placeholder="E.g. productName, recipient" required="true"/> <div> <basic-select items="variableTypes" ng-model="it.sourceType" bind-value="id" bind-label="label" bind-annotation="description" annotation-layout="description" placeholder="Select type"> </basic-select> </div> <editable-list-input ng-if="it.sourceType=='TOOL_INPUT'" type="text" ng-model="it.toolInputDescription" placeholder="Input description for the LLM" required="true"/> <editable-list-input ng-if="it.sourceType=='QUERY_CONTEXT'" type="text" ng-model="it.contextPath" placeholder="JSONPath: e.g. dssUser.email" required="true"/> <input class="editable-list__input" ng-if="it.sourceType=='DSS_VARIABLE'" type="text" placeholder="DSS Variable name" ng-model="it.dssVariableName" bs-typeahead="dssVariablesOptions" /> <span ng-if="it.sourceType=='FORMULA'" style="width: 165px;display: inline-block;overflow: hidden;white-space: nowrap;text-overflow: ellipsis;">{{it.expression}}</span> <a ng-if="it.sourceType=='FORMULA'" ng-click="editFormula(it, $index)">Editor</a> </editable-list> </div> <h3 class="settings-section-title">Tool description</h3> <form class="dkuform-horizontal"> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type == 'ApiEndpoint'"> <form class="dkuform-horizontal"> <div class="control-group required"> <label class="control-label">Endpoint</label> <div class="controls"> <select ng-model="uiState.apiEndpoint" dku-bs-select="{'liveSearch': true, 'showContent': false}" data-width="100%" style="min-width: 400px;"> <option ng-repeat="c in availableApiEndpoints" value="{{c.id}}" title="{{c.id}}" ng-disabled="c.disabled" ng-attr-data-content="{{c.html}}"> {{c.name}} </option> </select> <div class="alert alert-warning mbot0 mtop8" ng-if="uiState.hasError"> The endpoint <span style="font-weight: bold;">{{uiState.persistedApiEndpointName}}</span> has been deleted, or you don’t have the required permissions to access or query it through the deployer. </div> <span class="help-inline">Only endpoints with an OpenAPI documentation are available</span> <div class="doctor-explanation mbot8" style="padding-bottom: 8px;" ng-if="!uiState.hasError"> <p>You can define the <strong>authorization</strong> to <strong>query an endpoint through the deployer</strong> in the settings of its deployment.</p> </div> </div> </div> <div class="control-group" ng-if="uiState.apiEndpoint"> <label for="description" class="control-label">Description</label> <div class="controls"> <textarea id="description" style="width:400px; height: 60px" ng-model="agentTool.params.$description" disabled/> <span class="help-inline">Parsed from the description of the operation defined in the OpenAPI documentation</span> <div class="doctor-explanation mtop8 mbot8"> <p>The resulting description must clearly state <strong>the role</strong> of the endpoint. It should also specify the <strong>expected input</strong>, as well as <strong>how to interpret the output</strong>. Indicating the exact format of both input and output is helpful for correct integration and usage.</p> <em>Example: The "Customer Success > Predict Churn" endpoint predicts the probability that a customer will churn, based on several criteria such as account age, recent activity level, number of support tickets, and subscription type. The output is a number between 0 (unlikely to churn) and 1 (very likely to churn).</em> </div> </div> </div> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> </form> </div> <div ng-if="agentTool.type == 'GenericStdioMCPClient'"> <form class="dkuform-horizontal" name="mcpToolEditor"> <div class="control-group"> <label class="control-label" for="command"> Configure settings below or </label> <div class="controls"> <a class="btn btn--outline btn--primary" ng-click="showMCPJsonConfigModal()" title="Fill server settings from an MCP JSON configuration"> Paste JSON config </a> </div> </div> <div class="control-group"> <label class="control-label" for="command"> Command </label> <div class="controls"> <input type="text" id="command" ng-model="agentTool.params.command"/> </div> </div> <div class="control-group"> <label class="control-label"> Arguments </label> <div class="controls"> <ng2-values-list [(items)]="agentTool.params.args" add-label="Add" value-placeholder="Argument"/> <span class="help-inline"> Add each argument separately. For example, <code>--some-key somevalue</code> is 2 arguments </span> </div> </div> <div class="control-group mcp-environment-variables"> <label class="control-label"> Environment variables </label> <div class="controls"> <ng2-connection-properties-list [(items)]="agentTool.params.env"></ng2-connection-properties-list> </div> </div> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> <div ng-include="'/templates/agent-tools/fragments/mcp-subtools.html'" /> </form> </div> <div ng-if="agentTool.type == 'RemoteMCPClient'"> <form class="dkuform-horizontal"> <div class="control-group"> <label class="control-label" for="connection"> Remote MCP server </label> <div class="controls"> <basic-select label-for-id="connection" items="availableRemoteMCPConnections" searchable="true" actions-box="true" placeholder="Select connection" ng-model="agentTool.params.connectionName" /> </div> <agent-tool-instructions-form agent-tool="agentTool" show-tool-description-modal="showToolDescriptionModal(agentTool)"></agent-tool-instructions-form> <div ng-include="'/templates/agent-tools/fragments/mcp-subtools.html'" /> </div> </form> </div> </div> </div> <div class="span6 offset0 mbot16" style="margin-left: 1%;"> <div class="generic-white-box"> <agent-tool-quicktest project-key="$stateParams.projectKey" agent-tool-id="$stateParams.agentToolId" agent-tool-type="agentTool.type" quick-test-query-str="agentTool.quickTestQueryStr" save-tool="saveIgnoringQuickTestQuery()" dataset-schema="datasetSchema"></agent-tool-quicktest> </div> </div> </div> <div ng-if="agentTool.type === 'InlinePython'" class="resizable-code-editor tool-agent__resizable-code-editor pad16"> <div class="left-pane fh oa"> <div class="generic-white-box tool-agent__generic-white-box"> <div ng-if="agentToolTypeUiData.label" class="settings-section-title mtop0"> {{agentToolTypeUiData.label}} </div> <div ng-if="agentToolTypeUiData.description" class="alert alert-info"> <span>{{agentToolTypeUiData.description}}.</span> <doclink ng-if="agentToolTypeUiData.documentationLink" page="{{agentToolTypeUiData.documentationLink}}" title="Read the documentation to learn more."/> </div> <div class="code-snippet-editor-wrapper" > <code-snippet-editor style="min-height: 300px;" code="agentTool.params.code" sample-type="'python'" categories="['py-llm-python-agent-tool']" save-category="'py-llm-python-agent-tool'" editor-options="editorOptions" resolve-code-for-preview-func="resolveCodeForPreviewFunc" resolve-code-for-insertion-func = "resolveCodeForInsertionFunc" > </code-snippet-editor> </div> </div> </div> <div class="right-pane fh oa"> <div class="generic-white-box tool-agent__generic-white-box"> <div block-api-error></div> <agent-tool-quicktest project-key="$stateParams.projectKey" agent-tool-id="$stateParams.agentToolId" agent-tool-type="agentTool.type" quick-test-query-str="agentTool.quickTestQueryStr" save-tool="saveIgnoringQuickTestQuery()" dataset-schema="datasetSchema"></agent-tool-quicktest> </div> </div> <div resizer="vertical" resizer-container=".resizable-code-editor" resizer-width="8" resizer-left=".left-pane" resizer-right=".right-pane"> <div class="vertical-handle" /> </div> </div> </div> <div class="pad16" ng-if="topNav.tab == 'settings'"> <div class="tool-agent row-fluid vertical-flex h100"> <div class="generic-white-box"> <div> <form class="dkuform-horizontal"> <div ng-if="agentToolTypeUiData.codeEnvSelectionSupported" code-env-selection-form="agentTool.params.codeEnvSelection" env-lang="'PYTHON'" selection-label="'Code env'"></div> <div ng-if="agentToolTypeUiData.containerExecutionSupported" container-selection-form="agentTool.params.containerExecSelection" selection-label="'Container execution'" inline-help="'It is recommended to run MCP servers inside containers.'"></div> <div ng-if="agentTool.type == 'VectorStoreSearch'" read-only="true" container-selection-form="knowledgeBank.containerExecSelection" selection-label="'Container execution'" inline-help="'Defined in Knowledge Bank settings'" container-specific-context="'RAG'" inherited-from="'instance'"></div> <dependency-component ng-show="isDependenciesEnabled()" current-dependencies="currentDependencies" add-dependency="addDependency(dependencyToAdd)" remove-dependency="removeDependency(index)" description="Declare Flow items (datasets, models and knowledge banks) used by this tool. They will appear as dependencies when the tool is added to a Visual agent." warning-msg="warningMsg" > </dependency-component> <h2 class="settings-section-title" ng-class="{mtop0: agentTool.type != 'VectorStoreSearch' && !agentToolTypeUiData.codeEnvSelectionSupported && !agentToolTypeUiData.containerExecutionSupported}">Advanced</h2> <div class="alert alert-info"> Configure advanced Dataiku-specific properties for this tool. Usually used at the direction of Dataiku Support. </div> <div class="control-group" ng-if="isToolRunWithKernelPool()"> <label for="single-instance" class="control-label">Single instance</label> <div class="controls"> <input id="single-instance" type="checkbox" ng-model="agentTool.singleInstance"/> <span class="help-inline">If checked, the tool calls will run sequentially on a single execution environment, preventing concurrent runs.</span> </div> </div> <div class="control-group" ng-if="agentTool.type == 'GenericStdioMCPClient'"> <label for="local-mcp-init-timeout" class="control-label">Server initialization timeout</label> <div class="controls"> <input id="local-mcp-init-timeout" type="number" min="0" step="1" ng-model="agentTool.params.initTimeout"/> <span class="help-inline">Maximum server initialization time, in seconds. Use 0 to disable.</span> </div> </div> <div class="control-group" ng-if="agentTool.type == 'GenericStdioMCPClient'"> <label for="local-mcp-request-timeout" class="control-label">Tool call timeout</label> <div class="controls"> <input id="local-mcp-request-timeout" type="number" min="0" step="1" ng-model="agentTool.params.requestTimeout"/> <span class="help-inline">Maximum tool execution time, in seconds. Use 0 to disable.</span> </div> </div> <div class="control-group"> <label class="control-label">Properties</label> <div class="controls"> <ng2-connection-properties-list [(items)]="agentTool.dkuProperties"></ng2-connection-properties-list> </div> </div> </form> </div> </div> </div> </div> <div class="pad16" ng-if="topNav.tab == 'logs' && agentTool && isToolRunWithKernelPool()"> <div class="container-fluid mtop16 fh oa"> <div block-api-error></div> <div class="noflex mbot8"> <button class="btn btn--primary" ng-click="listLogs()">Refresh</button> <button class="btn btn--danger" ng-click="clearLogs()" ng-disabled="!agentToolLogs || !agentToolLogs.length">Clear</button> </div> <div simple-logs-two-panes logs="agentToolLogs" obj-id="[$stateParams.projectKey, agentTool.id]" get-log="getLog" delete-log="deleteLog" download-url="logDownloadURL"/> </div> </div> <div class="pad16" ng-if="topNav.tab == 'history'"> <div class="container-fluid page-top-padding fh oa"> <div object-git-history object-type="AGENT_TOOL" object-id="$stateParams.agentToolId" project-key="$stateParams.projectKey" object-revertable="true" /> </div> </div> </div> </div> </div> <standardized-side-panel page="object" object-type="AGENT_TOOL" toggle-tab="{{ standardizedSidePanel.tabToToggle }}" close-on-click-outside="true"> </standardized-side-panel>