Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/charlie85270/recipes-parser
Natural language parser for recipes and lists of ingredients, units and quantity
https://github.com/charlie85270/recipes-parser
cooking ingredient ingredients ingredients-list parser recipes recipes-parser
Last synced: 29 days ago
JSON representation
Natural language parser for recipes and lists of ingredients, units and quantity
- Host: GitHub
- URL: https://github.com/charlie85270/recipes-parser
- Owner: Charlie85270
- License: mit
- Created: 2020-04-16T21:24:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-16T22:10:35.000Z (about 1 year ago)
- Last Synced: 2024-10-31T20:43:11.531Z (about 2 months ago)
- Topics: cooking, ingredient, ingredients, ingredients-list, parser, recipes, recipes-parser
- Language: TypeScript
- Homepage:
- Size: 1.33 MB
- Stars: 37
- Watchers: 5
- Forks: 8
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# recipes-parser
   
Parse recipes instructions (string text entry) and extract ingredients, units and quantity.
## Features
- Based on NLP (natural language processing) and [pegsjs](https://github.com/pegjs/pegjs "pegsjs") library
- Available in English and French, but has support for custom languages
## Install
```sh
npm install recipes-parser --save
```
## Usage
```ts
import fs from "fs";
import * as path from "path";
import RecipesParser from "recipes-parser";
import units from "recipes-parser/lib/nlp/en/units.json";
import globalUnit from "recipes-parser/lib/nlp/en/global_unit.json";
const rules = fs.readFileSync(
path.join(__dirname, `node_modules/recipes-parser/nlp/en/rules.pegjs`),
{
encoding: "utf8",
}
);
const parser = new RecipesParser(rules, units, globalUnit);
const results = parser.getIngredientsFromText(
["3 cl. fresh raspberries"],
true
);
```
### `getIngredientsFromText(instructions: string[], returnUnitKey?: boolean): object: IRecipeResult[]`
### instructions
The list of instructions. Supports NLP queries.
### returnUnitKey
If true return the matched key, if false return the matched text.
```ts
IRecipeResult {
result?: { // the result when matched OK
instruction: string; // the instruction parsed
unit: string; // the unit matched
amount: number; ; // the quantity calculated
ingredient: string; // the quantity matched
};
unknown: { // the result matched OK
instruction?: string; // the instructon parsed
reasons?: UNKNOWN_REASONS[]; // the array of reasons why matched is OK
};
}
enum UNKNOWN_REASONS {
PARSING = "mismatch during parsing",
PARSING_AMOUNT = "unknown amount",
PARSING_UNIT = "unknown unit",
NO_ENTRY = "unavailable ingredient"
}
```
#### Examples
Simple number detection: **1 kilogram of chicken**
```json
{
"result": {
"ingredient": "chicken",
"unit": "kg",
"amount": 1
}
}
```
Fraction number detection: **1/2 kilogram of chicken**
```json
{
"result": {
"ingredient": "chicken",
"unit": "kg",
"amount": 0.5
}
}
```
Approximation number detection: **2-3 teaspoons of sugar**
```json
{
"result": {
"ingredient": "sugar",
"unit": "teaspoon",
"amount": 2.5
}
}
```
Word number detection: **Seven teaspoons of sugar**
```json
{
"result": {
"ingredient": "sugar",
"unit": "teaspoon",
"amount": 7
}
}
```
Word and fraction number detection: **5 1/2 liter of milk**
```json
{
"result": {
"ingredient": "milk",
"unit": "liter",
"amount": 2.5
}
}
```
Word and number detection: **5 quarter of orange**
```json
{
"result": {
"ingredient": "orange",
"unit": "undefined",
"amount": 1.25
}
}
```
Abbreviation units detection: **5 tbsp of milk**
```json
{
"result": {
"ingredient": "orange",
"unit": "tablespoon",
"amount": 1.25
}
}
```
## License
MIT