https://github.com/hexenq/kuroshiro-analyzer-yahoo-webapi

Yahoo web morphological analyzer for kuroshiro.
https://github.com/hexenq/kuroshiro-analyzer-yahoo-webapi

analyzer hiragana japanese kanji katakana kuroshiro language morphology romaji webapi yahoo

Last synced: 28 days ago
JSON representation

Yahoo web morphological analyzer for kuroshiro.

• Host: GitHub
• URL: https://github.com/hexenq/kuroshiro-analyzer-yahoo-webapi
• Owner: hexenq
• License: mit
• Created: 2018-07-03T03:32:58.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-06-07T17:34:14.000Z (almost 4 years ago)
• Last Synced: 2025-04-19T09:58:42.988Z (about 1 month ago)
• Topics: analyzer, hiragana, japanese, kanji, katakana, kuroshiro, language, morphology, romaji, webapi, yahoo
• Language: JavaScript
• Size: 14.6 KB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kuroshiro-analyzer-yahoo-webapi

[![Build Status](https://travis-ci.com/hexenq/kuroshiro-analyzer-yahoo-webapi.svg?branch=master)](https://travis-ci.org/hexenq/kuroshiro-analyzer-yahoo-webapi)

[![npm version](https://badge.fury.io/js/kuroshiro-analyzer-yahoo-webapi.svg)](http://badge.fury.io/js/kuroshiro-analyzer-yahoo-webapi)

    

        Package

        kuroshiro-analyzer-yahoo-webapi

    

    

        Description

        Yahoo WebAPI morphological analyzer for kuroshiro.

    

    

        Compatibility

        Node

        ✓ (>=6)

    

    

        Browser

        ✗

    

## Attention

This plugin will no longer be compatible with browser since Yahoo YQL service was retired at Jan 3, 2019. Please update to the latest version of kuroshiro-analyzer-yahoo-webapi.

## Install

```sh

$ npm install kuroshiro-analyzer-yahoo-webapi

```

## Usage with kuroshiro

### Configure analyzer

This analyzer utilizes [Yahoo WebAPI of morphological analysis service](https://developer.yahoo.co.jp/webapi/jlp/ma/v1/parse.html). 

Before you start, you should register your application in Yahoo to get a APP ID. Please visit the link above for more information. 

You need to specify your Yahoo application ID when initializing the analyzer.

```js

import YahooWebAnalyzer from "kuroshiro-analyzer-yahoo-webapi";

const analyzer = new YahooWebAnalyzer({

    appId: "YOUR_YAHOO_APP_ID",

});

await kuroshiro.init(analyzer);

```

### Initialization Parameters

- `appId`: Your Yahoo application ID

- `timeout`: *Optional* Request timeout in millisecond

## Notice

This analyzer might not give optimized converted result when converting kanji to romaji with kuroshiro since Yahoo Web API lacks information of pronunciation in analysis result.