npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

veritone-json-schemas

v1.2.0

Published

JSON Schemas, their examples, and helper functions used across Veritone

Downloads

1,150

Readme

veritone-json-schemas

This repo contains all the static JSON schemas used by Veritone. This does not include the user-defined schemas registered through Veritone Developer, just the ones that are core to our platform.

Usage

This package exports a map of valid validation contract names to their validating functions and looks like the following:

	{
		VALIDATORS: {
		  "transcript": validateTranscript
		  "object: validateObject
          ...
    },
    validateTranscript: fn(),
    validateObject: fn(),
    ...
	}

It also outputs all the json-schemas and the valid and invalid examples used in our tests for reference and use in non-javascript contexts.

PLEASE NOTE that the json-schema validation ecosystem is not 100% compatible. Different json-schema parsers and validators may behave slightly differently. At Veritone, we use ajv which works great with the draft-07 json-schemas we've written. And we try to keep our schemas simple and not use too many advanced features to increase the chance of compatibility with other packages. So if you do use another package to parse our json-schemas, hopefully things will "just work" but don't be surprised if there's a few quirks.

AI Object Notation (AION)

The AION validator is in a different class than the other validators. Most validators are tied to the validationContracts value and are for validating a file for a specific capability like transcription, concepts, object detection, etc. In contrast the AION validator will validate an entire file regardless of what specific types of data it represents. Just because a file is a valid AION file does not automatically make it valid for any given capability as different capabilities require specific fields for that capability. For instance, a transcription file MUST contain a series of words to be valid, but an AION file only MAY contain a series of words. Being a valid AION file is necessary for a capability but not sufficient for a capability.

So what is the AION validator for then? It has two purposes:

  1. It enforces a schema that validates any application/vnd.veritone.aion+json Media Type file (f.k.a. MIME Types). See IANA's list of Media Types for details.
  2. It can be used for any "vtn-standard" file, even those for which a specific validation contract is not available. For instance, at the time of writing, there is no specific validation contract for validating "location detection", but you can use the AION validator to ensure that your GPS data conforms to the expected format.

Contributing

See the veritone-sdk README for full information.

Local Development

  1. yarn install to install dependencies.
  2. run yarn test to run the schema validator against all the examples.

License

Copyright 2019-2021, Veritone Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.