Serialize and deserialize chains #11

andresgutgon · 2025-01-02T12:12:32Z

What?

The short version is that we want a way to serialize the chain to be stored in a cache system. Things that have to be serialized are the ast of the prompt and the scope. Now Scopes are JS classes that we need to transform into serializable JS objects

More details in this PR

TODO

Add ESlint 9 + Fix Prettier + Add CI 💅
Serialize ast
Serialize scope
Serialize adapter
Serialize compilerOptions
Add tests for serialize
Implement deserialize to read from a string OR JS object or JSON-like data and build a chain
Add tests for deserialize

Adapter

Adapter is a class so it needs to be serialized. Maybe just a reference to the identifier default, openai, anthrophic,...

NOTE

Added .prettierrc so some unrelated changes

src/compiler/chain.ts

package.json

src/compiler/chain.ts

src/compiler/chain-serialize.test.ts

src/compiler/deserializeChain.ts

neoxelox · 2025-01-03T09:57:42Z

src/compiler/deserializeChain.ts

+    const compilerOptions = serialized.compilerOptions || {}
+
+    if (
+      typeof serialized !== 'object' ||


I don't think this is a rigorous check because Arrays will also be true for this. I saw this check Variable.constructor === Object is more rigorous. https://www.geeksforgeeks.org/how-to-check-if-a-value-is-object-like-in-javascript/

But an array is not a valid serialized value

Then why are you checking that these are objects?

Yep, honestly this was AI generated 😂

neoxelox · 2025-01-03T10:05:26Z

src/compiler/deserializeChain.test.ts

+      </step>
+    `)
+
+    const chain = new Chain({ prompt, adapter: Adapters.openai })


Do more tests that include parameters and compile options

Also a test that tests that consecutive serialize(deserialize(serialize())) operations do not degrade the state of the chain would be nice too

How is it possible to degrade the state?

idk we could break something in the future, the test is to ensure we catch that

What I mean is that for example, serialize(deserialize(serialize())) == serialize()

We want to allow to store prompt state half compiled. This is helpful when using tool calls where user needs to receive a response from the AI that contains a tool call, do some work and respond back with the result of that work. In this scenario we need to serialize current compilation state to restart the compilation from that point.

src/compiler/scope.ts

src/compiler/chain.ts

neoxelox · 2025-01-03T10:16:02Z

src/compiler/deserializeChain.ts

+    const compilerOptions = serialized.compilerOptions || {}
+
+    if (
+      typeof serialized !== 'object' ||


Then why are you checking that these are objects?

neoxelox · 2025-01-03T10:17:07Z

src/compiler/deserializeChain.test.ts

+      </step>
+    `)
+
+    const chain = new Chain({ prompt, adapter: Adapters.openai })


idk we could break something in the future, the test is to ensure we catch that

neoxelox · 2025-01-03T10:18:01Z

src/compiler/deserializeChain.test.ts

+      </step>
+    `)
+
+    const chain = new Chain({ prompt, adapter: Adapters.openai })


What I mean is that for example, serialize(deserialize(serialize())) == serialize()

andresgutgon added the 🚧 wip Work in Progress label Jan 2, 2025

andresgutgon changed the title ~~Serialize chains~~ Serialize and deserialize chains Jan 3, 2025

andresgutgon removed the 🚧 wip Work in Progress label Jan 3, 2025

andresgutgon force-pushed the feature/serialize-chain branch from c9473ff to 160ec67 Compare January 3, 2025 08:39

andresgutgon requested a review from neoxelox January 3, 2025 08:41

andresgutgon commented Jan 3, 2025

View reviewed changes

src/compiler/chain.ts Show resolved Hide resolved