HyperData

HyperData · GPT Actions

hyperdata_retreval

API Gateway for retrieving datasets with a Google Cloud Functions backend

  • POST /get_datasetRetrieve dataset link
  • POST /find_available_datasetsFind available datasets
  • POST /visualize_datasetVisualize dataset
Original API schema
openapi: 3.1.0
info:
  title: hyperdata_retreval
  description: API Gateway for retrieving datasets with a Google Cloud Functions backend
  version: 1.0.0
servers:
  - url: https://hypergptgateway-dc27nwei.ue.gateway.dev
paths:
  /get_dataset:
    post:
      summary: Retrieve dataset link
      operationId: getDataset
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_uuid:
                  type: string
                attribute_uuid:
                  type: string
                dataset_name:
                  type: string
                is_website:
                  type: boolean
                is_company:
                  type: boolean
                is_location:
                  type: boolean
              required:
                - entity_uuid
                - attribute_uuid
                - dataset_name
                - is_website
                - is_company
                - is_location
      responses:
        '200':
          description: Successful response with dataset download link.
          content:
            application/json:
              schema:
                type: object
                properties:
                  download_link:
                    type: string
                  dataset_name:
                    type: string
        '400':
          description: Bad request if the input is not valid.
        '500':
          description: Internal server error.
  /find_available_datasets:
    post:
      summary: Find available datasets
      operationId: findAvailableDatasets
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                dataset_description:
                  type: string
              required:
                - dataset_description
      responses:
        '200':
          description: Successful response with available datasets.
          content:
            application/json:
              schema:
                type: object
                properties:
                  website:
                    type: array
                    items:
                      type: object
                      properties:
                        enity_uuid:
                          type: string
                        attribute_uuid:
                          type: string
                        dataset_name:
                          type: string
                  company:
                    type: array
                    items:
                      type: object
                      properties:
                        enity_uuid:
                          type: string
                        attribute_uuid:
                          type: string
                        dataset_name:
                          type: string
                  location:
                    type: array
                    items:
                      type: object
                      properties:
                        enity_uuid:
                          type: string
                        attribute_uuid:
                          type: string
                        dataset_name:
                          type: string
  /visualize_dataset:
    post:
      summary: Visualize dataset
      operationId: visualizeDataset
      x-google-backend:
        address: https://us-east1-hyperfunctions.cloudfunctions.net/visualizeDataset
      consumes:
        - application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                dataset_name:
                  type: string
                raw_data_url:
                  type: string
              required:
                - dataset_name
                - raw_data_url
      responses:
        '200':
          description: Successful response with visualization link.
          content:
            application/json:
              schema:
                type: object
                properties:
                  visualization_link:
                    type: string
                    example: "https://storage.googleapis.com/dataset-visualization"
        '400':
          description: Bad request if the input is not valid.
        '500':
          description: Internal server error.