Versions Compared

Old Version 72

changes.mady.by.user Sohaib Shaikh

Saved on

compared with

New Version 73

changes.mady.by.user Sohaib Shaikh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Type: Nearly all aspects of the C3 AI Suite (e.g., data, machine learning models, cloud-provider microservices) are stored and accessed through C3.ai Types. C3.ai Types are logical objects akin to a Java class, and contain 'fields' and 'methods'. Some C3.ai Types are persisted to internal databases (like Postgres or Cassandra), while others are not. 
  • Field: A field of a C3.ai Type. Fields contain attributes or data associated with the C3.ai Type.
  • Method: A method declared on a C3.ai Type. Methods define business logic associated with the C3.ai Type. 
  • Vanity Url: The URL at which a specific tenant/tag of a C3.ai Cluster can be accessed. 
  • Cluster: A deployment of the C3 AI Suite. A C3.ai cluster is a collection of hardware or virtualized cloud instances (e.g., servers, databases, load balancers) used to run the C3 AI Suite and C3.ai Applications. The C3 AI Suite can run on any public or private cloud infrastructure or on a local machine (in a docker container).
  • Tenant: A logical partition of a C3.ai Cluster. All tenants in a C3.ai generally share the same compute & storage resources. Data within tenants, while stored in a single database, are logically separated. C3 AI Suite users on one tenant can't see data stored on another tenant. In other words, users are only able to view data for tenants, to which they are explicitly granted access.
  • Tag: A logical partition of a tenant. A single tag hosts one C3.ai application (or deployed package). 
  • Package: All the code a C3.ai developer writes for an application. The C3 AI Suite runs a package on a tag. 
  • Provisioning: Deploying a package onto a tenant/tag in a C3.ai Cluster. 
  • Static Console: A browser-based tool that C3.ai developers use to interact with the C3 AI Suite. Static console is available on all modern browsers, including Google Chrome, Mozilla Firefox, and Apple Safari. C3.ai developers use the console to query data, evaluate expressions, view documentation, monitor environments, develop and test code, and manage environment configurations/ . You can access the static console at the url 'https://<vanity_url>/static/console' (Replace <vanity_url> with your vanity url.)
  • Metric: Expressions that transform raw data into a time-series. 

...

To learn more about the architecture of a C3.ai cluster, please see the C3.ai Developer Documentation Training Resources here:

Provision a C3.ai Package

To provision , your C3.aipackage ai package to your C3.ai tag, follow the instructions available at the DTI Provisioning Guide. To run the examples in this guide, you will need to provision the 'baseCovidDataLake' by following the directions under 'COVID-19 DataLake Provisioning' section.

...

The static console is the main location from which C3 developers typically configure and tool that C3.ai developers use to interact with the C3 AI Suite. We However, we anticipate however, that most DTI researchers members will use Python (via Jupyter notebook) for data analysis. That being said, the static console is an essential component part of working with the C3 AI Suite, and you will use it frequently. For example, the static console is the best place to find documentation tailored directly to your C3 Package. Its It's also a great place to quickly test some queries since as no specialized environments need to be set up to use it. It's ready to go in your browserStatic console is ready-to-go in all modern browsers, including Google Chrome, Mozilla Firefox, and Apple Safari.

Accessing the Static Console

Once your C3 package has been provisioned to your Tenant/Tag, Navigate you have provsioned a C3.ai package to your tag, navigate to the static console page. This is at , at this url: 'https://<vanity_url>/static/console' (Replace <vanity_url> with your the vanity url, provided in your C3.ai DTI Training Cluster Onboarding Email)., e.g., https://dti-mkrafczyk.c3dti.ai/static/console). The static console page looks like this:

The 'Tools' drop-down menu in the upper left-hand corner contains a menu to access some available list of available developer tools. Most The most relevant tool is the Provisioner, though there are also utilities for loading JavaScript files, debugging JS code, and inspecting Errors.

The 'Help' drop-down menu in the upper left-hand corner contains a quick menu allows users to access console documentation and a C3 Cluster hosted documentation portal.

Additionally, most Most tools are also accessible through a series of icons in the upper right-hand corner with a series of Icons:

Using the Static Console

Once you're at C3.ai developers interact with the static console , the primary method of interaction is through the JavaScript console of your tab in the browser. When the static console page loads (or when you run the c3ImportAll() command), JavaScript methods associated with all of your Package's defined Types C3.ai Types are populated. This allows you to You can write and run JavaScript code right directly in the console tab to interact with your C3.ai Package.

Most browsers use the keyboard shortcut You can also open Javascript console with the 'Ctrl+Shift+I' to open the JavaScript console. It is also usually keyboard shortcut (in most browsers). Javascript console is also available through the browser's developer tools. If the 'Ctrl+Shift+I' keyboard shortcut doesn't work for you, look at your browsers documentation for the review your browser's documentation on developer tools. With the JavaScript console open, the static console looks like this on the Firefox browserHere's how the static console looks in firefox, with the JavaScript console open:

Finally, we can enter let's write some JavaScript code commands to see the console in action!

Console Commands

We review here several highly used Here are common JavaScript console commands which are available used on the static console page.

  • c3ImportAll: A console command which loads the API of the current C3 Package. This is necessary all the C3.ai Types from your package into the static console. Always be sure refresh the static console page or run c3ImportAll(), after provisioning a new Pacakge if you haven't refreshed your static console pagepackage.
  • c3Grid: A console command to display a table of data contained stored within a C3.ai Type. (e.g., data returned from a fetch operation, or an evaluate operation among many others).
  • c3Viz: A console command which can to produce quick visualizations of or plots for some C3.ai Types. (e.g., timeseries time-series data like EvalMetricsResult)
  • c3ShowType: A console command which produces to view documentation about for a given typeC3.ai Type. (e.g., c3ShowType(OutbreakLocation))

Official C3.ai

...

Training Resources on Static Console

...