> For the complete documentation index, see [llms.txt](https://docs.3dolphins.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.3dolphins.ai/5.1.x/api/bot-api/npl-api.md).
# NLP API
Natural language processing (NLP) APIs are used to analyze and classify text much more efficiently and accurately than even humans could.
### **Get Similarity Result by Sentence**
| Method | POST |
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/similarity |
| Header | Authorization : Bearer \[generatedToken] |
| Body | {
“lang”: “Indonesia”,
“sentence1”: “cara mendaftarkan akun”,
“sentence2”: “cara mendaftarkan account”,
“nouns1”: \[
“akun”
],
“nouns2”: \[
“account”
],
“verbs1”: \[
“akun”
],
“primaryTerms”: \[
“string”
]
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: 0.13979776251968268,
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get Noun Ambiguity Score**
| Method | POST |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/wordNeighborList |
| Header | Authorization **:** Bearer \[generatedToken] |
| Body | {
“lang”: “Indonesia”,
“sentence1”: “Dia datang kemari memberi tahu”,
“sentence2”: “”,
“nouns1”: \[
“memberi tahu”
],
“nouns2”: \[
“memberi informasi”
],
“verbs1”: \[
“memberi”
],
“primaryTerms”: \[
“string”
]
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: 0,
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get Word Neighbor Result by Word**
| Method | POST |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/wordNeighbor |
| Header | Authorization : Bearer \[generatedToken] |
| Body | {
“lang”: “Indonesia”,
“word1”: “adm”,
“word2s”: \[
“admin”
]
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: 0.27198508381843567,
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get Word Neighbor List**
| Method | POST |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/wordNeighborList |
| Header | Authorization : Bearer \[generatedToken] |
| Body | {
“lang”: “Indonesia”,
“word1”: “atm terdekat”,
“word2s”: \[
“atm dekat sini”
]
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: \[
“sambungkan”,
“customer”,
“care”
],
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get Sensitive Words**
| Method | POST |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/word/sensitive |
| Header | Authorization : Bearer \[generatedToken] |
| Body | {
“sentence”: “sambungkan ke cs”
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: \[
“sambungkan”,
“customer”,
“care”
],
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get Classification Active Module**
| Method | GET |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/classify/active |
| Header | Authorization : Bearer \[generatedToken] |
| Body | |
| Status | 200 |
| Response | {
“status”: “success”,
“data”: \[
“Gabriel – First Media”,
“Error Message Code”,
“Services”
],
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get classification value**
| Method | POST |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/classify/module |
| Header | Authorization : Bearer \[generatedToken] |
| Body | {
“module”: “Services”,
“message”: “Hallo”
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: {
“module”: “Services”,
“message”: “Hallo”,
“category”: “default”
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
### **Get classification value**
| Method | POST |
| ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Media Type | application/json |
| URL | http\://\[server]/dolphin/apiv1/graph/nlp/classify/enabled |
| Header | Authorization : Bearer \[generatedToken] |
| Body | {
“message”: “Hallo”,
“start”: 1,
“count”: 10
}
|
| Status | 200 |
| Response | {
“status”: “success”,
“data”: {
“message”: “Hallo”,
“categories”: \[
“default”,
“default”
],
“modules”: \[
“Error Message Code”,
“Services”
]
},
“hasMore”: false,
“nextIndex”: 0,
“prevIndex”: 0,
“totalResults”: 0
}
|
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.3dolphins.ai/5.1.x/api/bot-api/npl-api.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.