assistant-conversation-nodejs - GitLite

KO | EN

gitlite — search

#javascript #react #typescript #llm #golang #rust #macos #nodejs #java #windows #awesome #vue #awesome-list #open-source

assistant-conversation-nodejs

(★ 110)

A developer friendly way to fulfill Actions SDK handlers for the Google Assistant

파일 탐색기

최종 버전 다운로드 (.zip)

- ci.sh
- coverage.sh
- docs.sh
- lint.js
- - assistant.test.ts
  - auth.test.ts
  - common.test.ts
- - schema.ts
- - conv.ts
  - conversation.ts
  - index.ts
- - express.ts
  - framework.ts
  - index.ts
  - lambda.ts
- assistant.ts
- auth.ts
- common.ts
- index.ts
- logger.ts
.gitignore
.npmignore
.nycrc.json
CHANGELOG.md
CONTRIBUTING.md
LICENSE
package.json
README.md
tsconfig.json
tslint.json
typedoc.json

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/actions-on-google/assistant-conversation-nodejs

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd assistant-conversation-nodejs

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Actions SDK Node.js Fulfillment Library

*:warning: Warning: Conversational Actions will be deprecated on June 13, 2023. For more information, see [Conversational Actions Sunset](https://goo.gle/ca-sunset).*

This fulfillment library exposes a developer friendly way to fulfill Actions SDK handlers for the Google Assistant.

* [Fulfillment Library GitHub repo](https://github.com/actions-on-google/assistant-conversation-nodejs)
* [Fulfillment Library reference docs](https://actions-on-google.github.io/assistant-conversation-nodejs/)
* [Actions on Google docs](https://developers.google.com/assistant)
* [Actions on Google samples](https://developers.google.com/assistant/actions/samples)

[![NPM Version](https://img.shields.io/npm/v/@assistant/conversation.svg)](https://www.npmjs.org/package/@assistant/conversation)
[![Build Status](https://travis-ci.org/actions-on-google/assistant-conversation-nodejs.svg?branch=master)](https://travis-ci.org/actions-on-google/assistant-conversation-nodejs)

## Setup Instructions

Make sure Node.js >=10.18.0 is installed.

Install the library with either `npm install @assistant/conversation` or `yarn add @assistant/conversation` if you use yarn.

### Example Usage
```javascript
// Import the appropriate service and chosen wrappers
const {
  conversation,
  Image,
} = require('@assistant/conversation')

// Create an app instance
const app = conversation()

// Register handlers for Actions SDK

app.handle('<YOUR HANDLER NAME>', conv => {
  conv.add('Hi, how is it going?')
  conv.add(new Image({
    url: 'https://developers.google.com/web/fundamentals/accessibility/semantics-builtin/imgs/160204193356-01-cat-500.jpg',
    alt: 'A cat',
  }))
})
```

### Frameworks

Export or run for your appropriate framework:

#### Firebase Functions
``` javascript
const functions = require('firebase-functions')

// ... app code here

exports.fulfillment = functions.https.onRequest(app)
```

#### Actions Console Inline Editor
```javascript
const functions = require('firebase-functions')

// ... app code here

// name has to be `ActionsOnGoogleFulfillment`
exports.ActionsOnGoogleFulfillment = functions.https.onRequest(app)
```

#### Self Hosted Express Server
```javascript
const express = require('express')
const bodyParser = require('body-parser')

// ... app code here

const expressApp = express().use(bodyParser.json())

expressApp.post('/fulfillment', app)

expressApp.listen(3000)
```

#### AWS Lambda API Gateway HTTP proxy integration
```javascript
// ... app code here

exports.fulfillment = app
```

### Next Steps

Take a look at the docs and samples linked at the top to get to know the platform and supported functionalities.

## Library Development Instructions
This library uses `yarn` to run commands. Install yarn using instructions from https://yarnpkg.com/en/docs/install or with npm: `npm i -g yarn`.

Install the library dependencies with `yarn`. If you want to run any of the sample apps, follow the instructions in the sample README.

## Functionality

Public interfaces, classes, functions, objects, and properties are labeled with the JSDoc `@public` tag and exported at the top level. Everything that is not labeled `@public` and exported at the top level is considered internal and may be changed.

## References & Issues
+ Questions? Go to [StackOverflow](https://stackoverflow.com/questions/tagged/actions-on-google) or [Assistant Developer Community on Reddit](https://www.reddit.com/r/GoogleAssistantDev/).
+ For bugs, please report an issue on Github.
+ Actions on Google [Documentation](https://developers.google.com/assistant)
+ Actions on Google [Codelabs](https://codelabs.developers.google.com/?cat=Assistant).

## Make Contributions
Please read and follow the steps in the [CONTRIBUTING.md](CONTRIBUTING.md).

## License
See [LICENSE](LICENSE).