[docs] Add guide for implementing typescript agent #452

piligrinik · 2024-12-18T21:10:40Z

Added guide for implementing ts agent with corresponding example code.

Important

Add a detailed guide and example code for implementing TypeScript agents in the documentation.

Documentation:
- Added ts_agent_guide.md to provide a detailed guide for implementing TypeScript agents.
- Updated index.md to include a link to the new TypeScript agent guide.
Examples:
- Added agent.ts and client.ts in docs/examples/TypeScript/ to demonstrate TypeScript agent implementation.
Guide Content:
- Covers steps for setting up input/output constructions, creating ScClient, implementing agent logic, and registering the agent.
- Includes FAQs addressing differences between C++ and TypeScript agents.

^{This description was created by}^{for 57bb8fb. It will automatically update as commits are pushed.}

Co-authored-by: 271ali <[email protected]>

NikitaZotov · 2025-01-11T12:21:12Z

docs/examples/TypeScript/agent.ts

+
+
+export const check = async(action: ScAddr,keynodes: Record<string, ScAddr>) => {
+    const checkTemplate = new ScTemplate();
+    checkTemplate.triple(                        // класс_действия
+        keynodes["get_set_power_action"],  //   |
+        ScType.EdgeAccessVarPosPerm,             //   \/
+        action,                                  // действие
+    );
+    const checkResult = await client.templateSearch(checkTemplate);
+    if (checkResult.length==0)
+        {
+            return false;
+
+        }
+    return true;
+}


Suggested change

export const check = async(action: ScAddr,keynodes: Record<string, ScAddr>) => {

const checkTemplate = new ScTemplate();

checkTemplate.triple( // класс_действия

keynodes["get_set_power_action"], // |

ScType.EdgeAccessVarPosPerm, // \/

action, // действие

);

const checkResult = await client.templateSearch(checkTemplate);

if (checkResult.length==0)

{

return false;

}

return true;

}

export const check = async(action: ScAddr,keynodes: Record<string, ScAddr>) => {

const checkTemplate = new ScTemplate();

checkTemplate.triple( // класс_действия

keynodes["get_set_power_action"], // |

ScType.EdgeAccessVarPosPerm, // \/

action, // действие

);

const checkResult = await client.templateSearch(checkTemplate);

return checkResult.length === 0;

}

NikitaZotov · 2025-01-11T12:23:57Z

docs/examples/TypeScript/agent.ts

+    const actionFinishedSuccessfully = 'action_finished_successfully';
+    const actionFinishedUnsuccessfully = 'action_finished_unsuccessfully';
+    const nrelResult = 'nrel_result';
+    const nrelSetPower="nrel_set_power";


Suggested change

const nrelSetPower="nrel_set_power";

const nrelSetPower = "nrel_set_power";

NikitaZotov · 2025-01-11T12:24:09Z

docs/examples/TypeScript/agent.ts

+        { id: actionInitiated, type: ScType.NodeConstClass },
+    ];   
+    const keynodes = await client.resolveKeynodes(baseKeynodes); //собрали все кейноды из БЗ
+    if(await check(actionNode,keynodes)===false) //сделали проверку на класс действия


Suggested change

if(await check(actionNode,keynodes)===false) //сделали проверку на класс действия

if (await check(actionNode,keynodes) === false) // сделали проверку на класс действия

NikitaZotov · 2025-01-11T12:24:18Z

docs/examples/TypeScript/agent.ts

+        { id: action, type: ScType.NodeConstClass },
+        { id: actionInitiated, type: ScType.NodeConstClass },
+    ];   
+    const keynodes = await client.resolveKeynodes(baseKeynodes); //собрали все кейноды из БЗ


Suggested change

const keynodes = await client.resolveKeynodes(baseKeynodes); //собрали все кейноды из БЗ

const keynodes = await client.resolveKeynodes(baseKeynodes); // собрали все кейноды из БЗ

NikitaZotov · 2025-01-11T12:24:41Z

docs/examples/TypeScript/agent.ts

+    const setAlias = '_set'; //узел множества
+    const elAlias = '_el'; //узел элемента множества


Suggested change

const setAlias = '_set'; //узел множества

const elAlias = '_el'; //узел элемента множества

const setAlias = '_set'; // узел множества

const elAlias = '_el'; // узел элемента множества

NikitaZotov · 2025-01-11T12:27:22Z

docs/examples/TypeScript/agent.ts

+    const powerSetConstruction = new ScConstruction(); //конструкция,где будет только множество и его мощность
+    const setPowerLinkAlias="set_power_link"; //метки для всех будущих элементов
+    const edgeCommonSetPowerAlias="edge_common_set_power";
+    const edgePosPermSetPowerAlias="edge_pos_perm_set_power";
+    const resultConstructionNodeAlias="result_construction_node";
+    const edgePosPermResultAlias="edge_pos_perm_result";
+    const edgeCommonResultAlias="edge_common_result";
+    powerSetConstruction.createLink(ScType.LinkConst,new ScLinkContent(power, ScLinkContentType.String),setPowerLinkAlias);//создаем ссылку с числом                                              ссылка


Suggested change

const powerSetConstruction = new ScConstruction(); //конструкция,где будет только множество и его мощность

const setPowerLinkAlias="set_power_link"; //метки для всех будущих элементов

const edgeCommonSetPowerAlias="edge_common_set_power";

const edgePosPermSetPowerAlias="edge_pos_perm_set_power";

const resultConstructionNodeAlias="result_construction_node";

const edgePosPermResultAlias="edge_pos_perm_result";

const edgeCommonResultAlias="edge_common_result";

powerSetConstruction.createLink(ScType.LinkConst,new ScLinkContent(power, ScLinkContentType.String),setPowerLinkAlias);//создаем ссылку с числом ссылка

const powerSetConstruction = new ScConstruction(); // конструкция,где будет только множество и его мощность

const setPowerLinkAlias = "set_power_link"; // метки для всех будущих элементов

const edgeCommonSetPowerAlias = "edge_common_set_power";

const edgePosPermSetPowerAlias = "edge_pos_perm_set_power";

const resultConstructionNodeAlias = "result_construction_node";

const edgePosPermResultAlias = "edge_pos_perm_result";

const edgeCommonResultAlias = "edge_common_result";

powerSetConstruction.createLink(ScType.LinkConst, new ScLinkContent(power, ScLinkContentType.String), setPowerLinkAlias); // создаем ссылку с числом ссылка

NikitaZotov · 2025-01-11T12:27:46Z

docs/examples/TypeScript/agent.ts

+    powerSetConstruction.createEdge(ScType.EdgeDCommonConst,set,setPowerLinkAlias,edgeCommonSetPowerAlias); //соединяем ее с множеством дугой для отношений                                                       /\
+    powerSetConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[nrelSetPower],edgeCommonSetPowerAlias,edgePosPermSetPowerAlias); //соедиянемя nrel_set_power с предыдущей дугой          ||<--nrel_set_power


Suggested change

powerSetConstruction.createEdge(ScType.EdgeDCommonConst,set,setPowerLinkAlias,edgeCommonSetPowerAlias); //соединяем ее с множеством дугой для отношений /\

powerSetConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[nrelSetPower],edgeCommonSetPowerAlias,edgePosPermSetPowerAlias); //соедиянемя nrel_set_power с предыдущей дугой ||<--nrel_set_power

powerSetConstruction.createEdge(ScType.EdgeDCommonConst, set, setPowerLinkAlias, edgeCommonSetPowerAlias); // соединяем ее с множеством дугой для отношений /\

powerSetConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[nrelSetPower],edgeCommonSetPowerAlias,edgePosPermSetPowerAlias); //соедиянемя nrel_set_power с предыдущей дугой ||<--nrel_set_power

NikitaZotov · 2025-01-11T12:29:00Z

docs/examples/TypeScript/agent.ts

+        const resultConstruction = new ScConstruction(); //конструкция,где действие будет соединяться с предыдущей конструкцией отношением nrel_result
+        resultConstruction.createNode(ScType.NodeConst,resultConstructionNodeAlias); //создаем узел-посредний
+        resultConstruction.createEdge(ScType.EdgeDCommonConst,actionNode,resultConstructionNodeAlias,edgePosPermResultAlias);// соединяем с действием дугой для отношений
+        resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[nrelResult],edgePosPermResultAlias,edgeCommonResultAlias); //соедиянемя nrel_result с предыдущей дугой
+        resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,powerSetRes[powerSetConstruction.getIndex(setPowerLinkAlias)]);// соединяем узел-посредний со всеми элементами powerSetConstruction
+        resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,set);
+        resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,powerSetRes[powerSetConstruction.getIndex(edgeCommonSetPowerAlias)]);
+        resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,powerSetRes[powerSetConstruction.getIndex(edgePosPermSetPowerAlias)]);
+        resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,keynodes[nrelSetPower]);


Suggested change

const resultConstruction = new ScConstruction(); //конструкция,где действие будет соединяться с предыдущей конструкцией отношением nrel_result

resultConstruction.createNode(ScType.NodeConst,resultConstructionNodeAlias); //создаем узел-посредний

resultConstruction.createEdge(ScType.EdgeDCommonConst,actionNode,resultConstructionNodeAlias,edgePosPermResultAlias);// соединяем с действием дугой для отношений

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[nrelResult],edgePosPermResultAlias,edgeCommonResultAlias); //соедиянемя nrel_result с предыдущей дугой

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,powerSetRes[powerSetConstruction.getIndex(setPowerLinkAlias)]);// соединяем узел-посредний со всеми элементами powerSetConstruction

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,set);

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,powerSetRes[powerSetConstruction.getIndex(edgeCommonSetPowerAlias)]);

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,powerSetRes[powerSetConstruction.getIndex(edgePosPermSetPowerAlias)]);

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm,resultConstructionNodeAlias,keynodes[nrelSetPower]);

const resultConstruction = new ScConstruction(); // конструкция,где действие будет соединяться с предыдущей конструкцией отношением nrel_result

resultConstruction.createNode(ScType.NodeConst, resultConstructionNodeAlias); // создаем узел-посредний

resultConstruction.createEdge(ScType.EdgeDCommonConst, actionNode, resultConstructionNodeAlias, edgePosPermResultAlias); // соединяем с действием дугой для отношений

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[nrelResult], edgePosPermResultAlias, edgeCommonResultAlias); // соедиянемя nrel_result с предыдущей дугой

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm, resultConstructionNodeAlias, powerSetRes[powerSetConstruction.getIndex(setPowerLinkAlias)]); // соединяем узел-посредний со всеми элементами powerSetConstruction

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm, resultConstructionNodeAlias, set);

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm, resultConstructionNodeAlias, powerSetRes[powerSetConstruction.getIndex(edgeCommonSetPowerAlias)]);

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm, resultConstructionNodeAlias, powerSetRes[powerSetConstruction.getIndex(edgePosPermSetPowerAlias)]);

resultConstruction.createEdge(ScType.EdgeAccessConstPosPerm, resultConstructionNodeAlias, keynodes[nrelSetPower]);

NikitaZotov · 2025-01-11T12:29:57Z

docs/examples/TypeScript/agent.ts

+        const resultRes = await client.createElements(resultConstruction);
+        if (resultRes && resultRes.length > 0) {
+            const finalConstruction= new ScConstruction();
+            finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinished], actionNode);
+            finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinishedSuccessfully], actionNode);
+            await client.createElements(finalConstruction); 
+            return ;
+        }
+        const finalConstruction= new ScConstruction();
+        finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinished], actionNode);
+        finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinishedUnsuccessfully], actionNode);
+        await client.createElements(finalConstruction); 
+        return ;
+    }
+    const finalConstruction= new ScConstruction();
+    finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinished], actionNode);
+    finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinishedUnsuccessfully], actionNode);
+    await client.createElements(finalConstruction); 
+    return ;
+};


Suggested change

const resultRes = await client.createElements(resultConstruction);

if (resultRes && resultRes.length > 0) {

const finalConstruction= new ScConstruction();

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinished], actionNode);

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinishedSuccessfully], actionNode);

await client.createElements(finalConstruction);

return ;

}

const finalConstruction= new ScConstruction();

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinished], actionNode);

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinishedUnsuccessfully], actionNode);

await client.createElements(finalConstruction);

return ;

}

const finalConstruction= new ScConstruction();

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinished], actionNode);

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[actionFinishedUnsuccessfully], actionNode);

await client.createElements(finalConstruction);

return ;

};

const resultRes = await client.createElements(resultConstruction);

if (resultRes && resultRes.length > 0) {

const finalConstruction = new ScConstruction();

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[actionFinished], actionNode);

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[actionFinishedSuccessfully], actionNode);

await client.createElements(finalConstruction);

return;

}

const finalConstruction = new ScConstruction();

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[actionFinished], actionNode);

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[actionFinishedUnsuccessfully], actionNode);

await client.createElements(finalConstruction);

return;

}

const finalConstruction = new ScConstruction();

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[actionFinished], actionNode);

finalConstruction.createEdge(ScType.EdgeAccessConstPosPerm, keynodes[actionFinishedUnsuccessfully], actionNode);

await client.createElements(finalConstruction);

return;

};

NikitaZotov · 2025-01-11T12:30:24Z

docs/examples/TypeScript/client.ts

+import { SC_URL } from '@constants';
+import { ScClient,ScType,ScEventParams,ScEventType } from 'ts-sc-client';
+import { getSetPowerAgent } from "@agents/agent"
+
+async function testAgent() {
+    const actionInitiated = "action_initiated";
+    const keynodes = [
+        { id: actionInitiated, type: ScType.NodeConstNoRole },
+    ];
+
+    const keynodesAddrs = await client.resolveKeynodes(keynodes);
+
+    const eventParams = new ScEventParams(keynodesAddrs[actionInitiated], ScEventType.AddOutgoingEdge, getSetPowerAgent);
+    await client.eventsCreate([eventParams]); 
+}
+
+export const client = new ScClient(SC_URL);
+testAgent();
+
+
+
+
+


Suggested change

import { SC_URL } from '@constants';

import { ScClient,ScType,ScEventParams,ScEventType } from 'ts-sc-client';

import { getSetPowerAgent } from "@agents/agent"

async function testAgent() {

const actionInitiated = "action_initiated";

const keynodes = [

{ id: actionInitiated, type: ScType.NodeConstNoRole },

];

const keynodesAddrs = await client.resolveKeynodes(keynodes);

const eventParams = new ScEventParams(keynodesAddrs[actionInitiated], ScEventType.AddOutgoingEdge, getSetPowerAgent);

await client.eventsCreate([eventParams]);

}

export const client = new ScClient(SC_URL);

testAgent();

import { SC_URL } from '@constants';

import { ScClient, ScType, ScEventParams, ScEventType } from 'ts-sc-client';

import { getSetPowerAgent } from "@agents/agent"

async function testAgent() {

const actionInitiated = "action_initiated";

const keynodes = [

{ id: actionInitiated, type: ScType.NodeConstNoRole },

];

const keynodesAddrs = await client.resolveKeynodes(keynodes);

const eventParams = new ScEventParams(keynodesAddrs[actionInitiated], ScEventType.AddOutgoingEdge, getSetPowerAgent);

await client.eventsCreate([eventParams]);

}

export const client = new ScClient(SC_URL);

testAgent();

NikitaZotov · 2025-01-31T16:08:20Z

@ellipsis, review this PR, please

ellipsis-dev

❌ Changes requested. Reviewed everything up to 57bb8fb in 2 minutes and 13 seconds

More details

Looked at 697 lines of code in 4 files
Skipped 2 files when reviewing.
Skipped posting 2 drafted comments based on config settings.

1. docs/examples/TypeScript/agent.ts:43

Draft comment:
Use '===' instead of '==' for strict equality check.

    if(await check(actionNode,keynodes) === false)

Reason this comment was not posted:
Marked as duplicate.

2. docs/examples/TypeScript/client.ts:18

Draft comment:
Consider renaming the function 'testAgent' to something more descriptive like 'registerAgent' to better reflect its purpose.
Reason this comment was not posted:
Confidence changes required: 50%
The code uses '==' for comparison, which is not a best practice in JavaScript/TypeScript. '===' should be used instead for strict equality checks.

Workflow ID: wflow_dM6wAwde8VeybEiz

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2025-01-31T16:10:48Z

docs/examples/TypeScript/agent.ts

+        action,                                  // действие
+    );
+    const checkResult = await client.templateSearch(checkTemplate);
+    if (checkResult.length==0)


Use '===' instead of '==' for strict equality check.

Suggested change

if (checkResult.length==0)

if (checkResult.length === 0)

ellipsis-dev · 2025-01-31T16:10:48Z

docs/examples/TypeScript/agent.ts

+        elements.push(result[i].get(elAlias));
+    }
+    const set = result[0].get(setAlias); // выбираем узел самого множества из первой найденной конструкции, потому что узел множества он и в Африке узел множества
+    const power = elements.length.toString();;


Remove the extra semicolon at the end of the line.

Suggested change

const power = elements.length.toString();;

const power = elements.length.toString();

NikitaZotov · 2025-01-31T16:13:01Z

@ellipsis, could you fix my comments?

ellipsis-dev · 2025-01-31T16:13:18Z

It seems that there are no specific comments visible in the provided context that need to be addressed. Could you please clarify or point out the specific comments or issues you would like me to address in this pull request?

Responding to this comment by @NikitaZotov. For more information about Ellipsis, check the documentation.

Added guide for implementing typescript agent.

57bb8fb

Co-authored-by: 271ali <[email protected]>

piligrinik closed this Dec 18, 2024

piligrinik reopened this Dec 18, 2024

NikitaZotov assigned piligrinik Dec 20, 2024

NikitaZotov requested review from NikitaZotov and MikhailSadovsky December 20, 2024 11:00

NikitaZotov changed the title ~~Added guide for implementing typescript agent.~~ [docs] Added guide for implementing typescript agent Dec 22, 2024

NikitaZotov changed the title ~~[docs] Added guide for implementing typescript agent~~ [docs] Add guide for implementing typescript agent Dec 22, 2024

NikitaZotov requested changes Jan 11, 2025

View reviewed changes

NikitaZotov added the 0.10.2 label Jan 31, 2025

NikitaZotov added this to the 0.10.2 milestone Jan 31, 2025

ellipsis-dev bot reviewed Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Add guide for implementing typescript agent #452

[docs] Add guide for implementing typescript agent #452

piligrinik commented Dec 18, 2024 •

edited by ellipsis-dev bot

Loading

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov Jan 11, 2025

NikitaZotov commented Jan 31, 2025

ellipsis-dev bot left a comment

ellipsis-dev bot Jan 31, 2025

ellipsis-dev bot Jan 31, 2025

NikitaZotov commented Jan 31, 2025

ellipsis-dev bot commented Jan 31, 2025

	const nrelSetPower="nrel_set_power";
	const nrelSetPower = "nrel_set_power";

	if(await check(actionNode,keynodes)===false) //сделали проверку на класс действия
	if (await check(actionNode,keynodes) === false) // сделали проверку на класс действия

	const keynodes = await client.resolveKeynodes(baseKeynodes); //собрали все кейноды из БЗ
	const keynodes = await client.resolveKeynodes(baseKeynodes); // собрали все кейноды из БЗ

		const setAlias = '_set'; //узел множества
		const elAlias = '_el'; //узел элемента множества

		powerSetConstruction.createEdge(ScType.EdgeDCommonConst,set,setPowerLinkAlias,edgeCommonSetPowerAlias); //соединяем ее с множеством дугой для отношений /\
		powerSetConstruction.createEdge(ScType.EdgeAccessConstPosPerm,keynodes[nrelSetPower],edgeCommonSetPowerAlias,edgePosPermSetPowerAlias); //соедиянемя nrel_set_power с предыдущей дугой \|\|<--nrel_set_power

	const power = elements.length.toString();;
	const power = elements.length.toString();

[docs] Add guide for implementing typescript agent #452

Are you sure you want to change the base?

[docs] Add guide for implementing typescript agent #452

Conversation

piligrinik commented Dec 18, 2024 • edited by ellipsis-dev bot Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NikitaZotov commented Jan 31, 2025

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Jan 31, 2025

Choose a reason for hiding this comment

ellipsis-dev bot Jan 31, 2025

Choose a reason for hiding this comment

NikitaZotov commented Jan 31, 2025

ellipsis-dev bot commented Jan 31, 2025

piligrinik commented Dec 18, 2024 •

edited by ellipsis-dev bot

Loading