Skip to content

Commit

Permalink
fixing docs (#1193)
Browse files Browse the repository at this point in the history
Signed-off-by: Dhrubo Saha <[email protected]>
  • Loading branch information
dhrubo-os authored Aug 9, 2023
1 parent d3d4122 commit 6a1a8f2
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Fork ml-commons by clicking the "Fork" button at the top of the [GitHub reposito
Clone your forked version of ml-commons to your local machine (replace `opensearch-project` in the command below with your GitHub username):

```bash
$ git clone [email protected]:opensearch-project/opensearch-py-ml.git
$ git clone [email protected]:opensearch-project/ml-commons.git
```

### Run OpenSearch
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```json
POST /_plugins/_ml/connectors/_create
{
"name": "<YOUR MODEL NAME>",
"description": "<YOUR MODEL DESCRIPTION>",
"version": "<YOUR MODEL VERSION>",
"name": "<YOUR CONNECTOR NAME>",
"description": "<YOUR CONNECTOR DESCRIPTION>",
"version": "<YOUR CONNECTOR VERSION>",
"protocol": "http",
"credential": {
"cohere_key": "<PLEASE ADD YOUR Cohere API KEY HERE>"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```json
POST /_plugins/_ml/connectors/_create
{
"name": "<YOUR MODEL NAME>",
"description": "<YOUR MODEL DESCRIPTION>",
"version": "<YOUR MODEL VERSION>",
"name": "<YOUR CONNECTOR NAME>",
"description": "<YOUR CONNECTOR DESCRIPTION>",
"version": "<YOUR CONNECTOR VERSION>",
"protocol": "http",
"parameters": {
"endpoint": "api.cohere.ai",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
```json
POST /_plugins/_ml/connectors/_create
{
"name": "<YOUR MODEL NAME>",
"description": "<YOUR MODEL DESCRIPTION>",
"version": "<YOUR MODEL VERSION>",
"name": "<YOUR CONNECTOR NAME>",
"description": "<YOUR CONNECTOR DESCRIPTION>",
"version": "<YOUR CONNECTOR VERSION>",
"protocol": "http",
"parameters": {
"endpoint": "api.openai.com",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```json
POST /_plugins/_ml/connectors/_create
{
"name": "<YOUR MODEL NAME>",
"description": "<YOUR MODEL DESCRIPTION>",
"version": "<YOUR MODEL VERSION>",
"name": "<YOUR CONNECTOR NAME>",
"description": "<YOUR CONNECTOR DESCRIPTION>",
"version": "<YOUR CONNECTOR VERSION>",
"protocol": "http",
"parameters": {
"endpoint": "api.openai.com",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
```json
POST /_plugins/_ml/connectors/_create
{
"name": "<YOUR MODEL NAME>",
"description": "<YOUR MODEL DESCRIPTION>",
"version": "<YOUR MODEL VERSION>",
"name": "<YOUR CONNECTOR NAME>",
"description": "<YOUR CONNECTOR DESCRIPTION>",
"version": "<YOUR CONNECTOR VERSION>",
"protocol": "aws_sigv4",
"credential": {
"access_key": "<PLEASE ADD YOUR AWS ACCESS KEY HERE>",
Expand Down

0 comments on commit 6a1a8f2

Please sign in to comment.