Contents x
    Blueprint Components and Configuration
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Blueprint Components and Configuration

    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Blueprint and Copilot Now Available in Private Preview

    We are excited to announce that our new Copilot and Blueprint features are now available to a select group of beta customers! This exclusive opportunity allows you to explore and test the latest capabilities of Blueprint before its official release.

    If you're interested in joining the beta program, click here to request access.

    How to Configure a Connector

    In this document we'll provides a step-by-step guide on setting up a YAML source configuration using
    GitHub's REST API as an example.

    Connector Section

    Connector Details

    connector:
  name: GitHubConnector 
  type: rest
    • name: Identifies the connector, in this case, GitHubConnector.
    • type: Specifies that the connector type is rest, indicating it will communicate using RESTful API calls.

    Base URL

    base_url: 'https://api.github.com'
    • base_url: Sets the base URL for all API requests.

    Default Headers

    default_headers:
  Authorization: 'Basic {YOUR_AUTH}'
  X-GitHub-Api-Version: '{YOUR_X_GITHUB_API_VERSION}'
  User-Agent: '{YOUR_USER_AGENT}'
    • Authorization: Used for authentication. The API requires the auth token to be a part of the headers for each request.
    • X-GitHub-Api-Version: Specifies the version of the GitHub API to use.
    • User-Agent: Identifies the client making the request.

    Variables Storages

    variables_storages:
  - name: results dir
    type: file_system
    path: storage/results/filesystem
  - name: results memory
    type: memory
    • results dir: Storage for results in the filesystem, specified by path.
    • results memory: In-memory storage for temporary data during processing.

    Variables Metadata

    variables_metadata:
  page_number:
    storage_name: results memory
    format: json
  last_result:
    storage_name: results memory
    format: json
  final_output_file:
    storage_name: results dir
    format: json
    • page_number: Tracks the current page of results being processed.
    • last_result: Stores the results of the last API call.
    • final_output_file: Holds the final output data in a file.

    Steps Section

    Was this article helpful?
    What's Next