Quick Start / How to

Hi,

I have a very preliminary “getting started” guide for CDF Records being processed now in the beta documentation. Should become available in the next few hours as a sub-page of the “Data Modeling Concepts and Features” topic using the Beta Documentation link.

This guide needs a few eyes from our engineers as well. But it’s a start…

Current edition (lots of mistakes in this page!): https://pr-2620.docs.preview.cogniteapp.com/cdf/dm/records/guides/records_getting_started

All 3 of the container schema examples define `usedFor: node` why is that? The rest of the documentation suggests to use `usedFor: record`.

Also, while using the latest cognite-sdk-7.87.0 the yaml content does not parse in `ContainerApply.load()`.

Error:

"c:\...\venv\Lib\site-packages\cognite\client\data_classes\data_modeling\data_types.py", line 74, in _load is_list=resource["list"], ~~~~~~~~^^^^^^^^ KeyError: 'list'
 

Seems you made the ‘list’ property mandatory on most property types. Just the `direct` is gracefully reading defaulting `is_list=resource.get("list", False),`.

Furthermore, the `direct_relation` prop type is not supported. Perhaps renamed to `direct`?

Do you plan fixing the documentation? Or do you plan fixing the SDK? 
Also, is there a version of the SDK that already fixes issues like those, so I do not have to waste time?

Hi ​@Jan Dolejsi,

You're right to call out those inconsistencies. Since this is beta documentation for a feature that isn't officially released yet, there are going to be errors, as ​@Thomas Sjølshagen explicitly mentioned above.

When it comes to the usedFor field in containers, right now, the API only supports node, edge, and all. Support for record is coming in the upcoming December release.

Also, Records isn't supported in any SDK yet. The SDK support is planned for early 2025. If you're trying to use the beta now, you'll need to work directly with the API.

If working with incomplete beta documentation and no SDK support isn't what you signed up for, it might be worth waiting rather than troubleshooting preview materials.

​@Everton Colling , I do appreciate this is Beta and I am happy to jump through hoops (this is a pretty great addition to CDF, so excited to bleed on the bleeding edeg!). But can you give a hint (here or in the getting started page) how to actually achieve the steps, if the SDK support is not there yet?

Observe that the getting started guide indicates how to create streams and how to ingest/query records. But it does not indicate how to create the container from the yaml text on the page. I guessed I need to parse it using ContainerApply.load(), which seems to be an existing functionality in the SDK that was not specific to Records.
And as the parsing fails, I am looking for help from other people that managed to apply the documentation more successfully. I just need a hint how to create a container before December. Thanks.