...
C3.ai keeps two types of documentation. First The first is that available on their documentation website:
https://developer.c3.ai/documentation?version=3
Second The second is available only from within a running C3.ai instance. This can be accessed primarily through the static console by running the
command 'c3ShowType(<TypeOfInterest>)', or from a c3-connected Jupyter Python notebook by running 'help(c3.<TypeOfInterest>)'.
Developer Documentation Site
...
Second is the search bar and results. Here, you can type enter a topic or C3 Type in, and get mostly relevant articles for that Type or topic.
...
For general topics such as evaluating Metrics, we recommend opening the Getting Started guide and searching for the topic you're interested in
either through Ctrl+F (Find) or by inspecting the table of contents. If you can't find exactly what you're looking for, next try typing your topic into
the search bar as this may sometimes surface a relevant article. If you still can't find information on the topic you're interested in, open
a ticket with the DTI asking for more information by emailing help@c3dti.ai. Describe the topic you think is lacking a description, and we'll
either provide an explanation on in this training guide somewhere, or prompt C3 to augment their documentation.
When looking at type information through the search function, only basic C3 Types will be available. All types you defined yourself in a C3 instance
will not be available. That said, Documentation on the base Types is often very helpful. Each Type entry contains a short description,
a list of types Types the type Type mixes in, the annotations defined on it, and a list of properties and methods along with where those methods came
from if they were inherited. Initially, the method descriptions are in a 'collapsed' state, and clicking on a method you're interested in should
expand it to provide a description along with a definition of the functions signature along with a list of arguments and expected values for
those arguments if necessary.
...
Finally, documentation for any type can be access accessed through the browser console by running the command 'c3ShowType(<TypeOfInterest>)'.
This will display a page giving a description of the type, links to the types it inherits, a list of annotations which are declared on it, and a list of
functions and properties either unique to that type or inherited through other types. Each property and function is described with a type or call
signature along with a description of that property and function.
Jupyter Notebook Documentation
If you're accessing the C3.ai platform through a Python Jupyter notebook, you can pull up the same Type documentation within Jupyter in a
similar way as you could with the C3 JavaScript Console. Instead of the 'c3ShowType()' command you'll run 'help(c3.<TypeOfInterest>)' to display
the documentation for that type in an output cell (Note the period after "c3"). In our experience the formatting in Jupyter makes it harder to read
than the C3 JS Console c3ShowType() output, plus it can be more difficult to search through with your browser's Find command.
Base C3 Types
The C3.ai platform comes with a number of built-in types which are used throughout, and are available in all C3.ai instances. These types all have
documentation accessible through the main C3.ai developer documentation here.
...