API Reference¶
See swagger Swagger documentation for more technical info. Note that unfortunatelly, the Swagger version of the NLP response is not correct. Use the information in this reference documentation instead.
Functions¶
Endpoint |
Type |
Request |
200 Result |
Description |
|---|---|---|---|---|
NLP Controller |
Semantic analysis of articles |
|||
/v2/nlp/analyze |
POST |
Analysis (same as G3 response) |
Semantic analysis of an article returning tags, entities, sentiment, etc. |
|
/v2/nlp/analyze/feedback |
POST |
Feedback on a particular analysis. |
||
Knowledgebase Controller |
Endpoints returning real-world information about tags and entities returned by the NLP controllers. |
|||
/v2/knowledgebase/details |
POST |
Map[string, Details] |
Information about tags and entities. |
|
/v2/knowledgebase/infoboxes |
POST |
Map[string, LangValueInfoBox] |
Information about tags and entities optimized for UI display. |
|
/v2/knowledgebase/redirects |
POST |
List[Redirects] |
Replacements for deprecated knowledge base entities. |
|
/v2/knowledgebase/search |
POST |
List[SearchResults] |
Searching knowledge base for entities. |
|
/v2/knowledgebase/stdforms |
POST |
Map[string, LangValueString] |
Standard forms of tags and entities in a particular language. |
|
Matcher Controller |
Endpoints recommending relevant articles and photos for articles. |
|||
/v2/photos |
GET |
Supported photo banks. |
||
/v2/photos/{dataset}/recommend |
POST |
Recommend photos for an article. |
||
/v2/photos/{dataset}/recommend/feedback |
POST |
Feedback on a particular recommendation. |
||
Request Objects¶
Response Objects¶
- Analysis
- AnalyzeFeedback
- AnalyzeFeedbackItem
- AnalyzeFeedbackSentiment
- Argument
- CharSpan
- Details
- Entity
- GkbProperty
- InfoBox
- Language
- LangValueInfoBox
- LangValueString
- Mention
- Paragraph
- PhotoData
- PhotosRecommendation
- PhotoTag
- RecommendFeedback
- RecommendFeedbackPhoto
- Relation
- Sentence
- Sentiment
- Support
- Tag
- TectoToken
- Token
- Vector