https://github.com/tonicai/structural-start-job

A Github Action to start a data generation job on your Tonic Structural workspace
https://github.com/tonicai/structural-start-job

Last synced: 2 months ago
JSON representation

A Github Action to start a data generation job on your Tonic Structural workspace

• Host: GitHub
• URL: https://github.com/tonicai/structural-start-job
• Owner: TonicAI
• License: mit
• Created: 2025-04-21T19:12:48.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-21T21:14:37.000Z (about 1 year ago)
• Last Synced: 2025-04-21T22:00:44.836Z (about 1 year ago)
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Start Generation Job

This action starts a data generation job for a specified workspace and returns the job ID.

## Inputs

- `workspace_id` (required): The workspace ID (GUID) for which to start a generation job

- `api_key` (required): Structural API key for authentication

- `api_url` (optional): Structural API base URL, defaults to 'https://app.tonic.ai'

- `strict_mode` (optional): Specifies generation mode, allowed values: "NotStrict", "RejectOnSchemaActions", "RejectOnAllSchemaItems", "NotApplicable"

- `diagnostic_logging` (optional): Enables diagnostic logging, defaults to false

## Outputs

- `job_id`: The ID of the started generation job

## Example Usage

```yaml

jobs:

  start-generation:

    runs-on: ubuntu-latest

    steps:

      - name: Start Generation Job

        id: start-job

        uses: TonicAI/structural-start-job@v1

        with:

          workspace_id: ${{ secrets.STRUCTURAL_WORKSPACE_ID }}

          api_key: ${{ secrets.STRUCTURAL_API_KEY }}

          strict_mode: "RejectOnSchemaActions"

      - name: Print Job ID

        run: echo "Started job with ID ${{ steps.start-job.outputs.job_id }}"

```