|
Download README.md from deepstack-ml/deepstack-api-v2-contracts: direct link, hf CLI and curl.
- Browser
- Download file 1.81 kB
-
https://huggingface.co/datasets/deepstack-ml/deepstack-api-v2-contracts/resolve/1e3bc19d329bf0c8537d0bd745583e851966c614/README.md
- Command line
-
hf download hf://datasets/deepstack-ml/deepstack-api-v2-contracts@1e3bc19d329bf0c8537d0bd745583e851966c614/README.md
-
curl -L -o README.md https://huggingface.co/datasets/deepstack-ml/deepstack-api-v2-contracts/resolve/1e3bc19d329bf0c8537d0bd745583e851966c614/README.md
1.81 kB
| license: cc-by-4.0 | |
| pretty_name: DeepStack API v2 contracts | |
| language: | |
| - en | |
| tags: | |
| - json-schema | |
| - api | |
| - forecasting | |
| - contracts | |
| size_categories: | |
| - n<1K | |
| viewer: false | |
| # DeepStack API v2 contracts | |
| The JSON Schemas of the DeepStack ML API v2 (`/v2/answers:stream`, `/v2/search`, `/v2/scenarios/runs`, | |
| `/v2/trackrecord`) and valid examples of each. `/v2` serves the same contracts as `/v1`: a GroundedAnswer is a | |
| GroundedAnswer, whoever asks. | |
| - **Items:** 34 files (12 schemas, 22 examples), listed in `manifest.json` with sha256, size, | |
| licence, source and rights per item. | |
| - **Package id:** `7726f3ef2d6c89a351740d8ea2a96ce1dffe6b3c1a0e6e868895457fd4415d64` (sha256 of the canonical list of item paths and hashes). | |
| - **Excluded:** 33 candidate files, each with its reason in `manifest.json` (negative fixtures are not | |
| examples; nothing that cites another source, names a model provider or names an open question is distributed). | |
| - **What it is not:** no reader data, no forecast of an open question, no passage of a paid or third-party source, no | |
| key or secret. The examples are synthetic fixtures: their numbers and texts are illustrations of the shape, not | |
| facts about any company. | |
| ## Licence | |
| Every item is DeepStack's own work, released under the **Creative Commons Attribution 4.0 International** licence | |
| (`cc-by-4.0`). The full legal code is in `LICENSE`. You may share and adapt the material for any purpose, provided you | |
| give appropriate credit: | |
| > DeepStack API v2 contracts, by DeepStack, licensed under CC BY 4.0. | |
| ## Verify | |
| `manifest.json` lists the sha256 of every file; the package id is reproducible from it. The package is built by | |
| `python -m deepstack_ml.publication.distribution` from the DeepStack repository, deterministically, and checked for | |
| leaks before it is uploaded. | |