Deploying an NLG Studio App
Once you have built your Studio project and tested it with your sample data, you can publish it as an application. Before it is published, you can only run the application via Preview Mode within the Studio interface. After it is published, it becomes a real application accessible in the cloud. You can continue to refine your application within Studio, but the published version is fixed until you republish a new version.
After your Studio project has been published, you can use (or allow other people to use) the application on large datasets. There are two ways to use an application:
Run Project from within the Studio interface. This is only useful for those with access to your project within Studio.
API Mode via a REST endpoint. This makes it possible to give anyone access to your application via an existing website or web application. Access to the endpoint is controlled by a project-specific API key.
Publishing Your Application
Click the Publish button in the Publish view. For more details about publishing, accessing the API endpoint, and generating an API key, see the Publish View topic.
If you just want to use the application directly yourself, see Run Project below. If you want to make your application available via a website or some other web application, see API Mode below.
Run Project
Run Project lets you run your published project from inside Studio. You can upload a CSV file or JSON file containing data, and download a version of that file that contains the results of running your application on that data.
You access Run Project in the Run Project tab within the Publish view. Before you can run the project, you must publish it (Run Project runs the latest published version of your project).
On the Run Project tab, you can either upload a data file to be used by the application or just use the sample data that you already have in the project. If you choose to upload a data file, you can either drag it into the window or specify it via the file browser window.
Note
The file you upload must be in CSV or JSON format.
Once the application has been run on the data, you will be offered a download of the results. This is a copy of your uploaded CSV or JSON file with an extra column added at the end of each row containing the results for that row.
For more information, see Publish View > Run Project.
API Mode
API mode makes your application available at a REST endpoint on the web that can be accessed by any web service that holds a valid API key. This makes it possible to embed calls to your NLG Studio application within web pages and other web services so that your users can receive dynamically generated content.
To make this work, you need two things:
The URL of the REST endpoint for the current published version of the application, which you are given when you publish the application.
A valid API key, which you can obtain (and regenerate) under API in the Publish view for the project.
Note
Only the owner of a project can generate API keys.
See Using a Studio app's API for more information on how to call the API.
See Publish View for information on publishing your project, getting the API endpoint, generating a key for it, and converting your data into the correct format for an API call.
