API Reference
See swagger Swagger documentation for more technical info.
Functions
The Media API V2 offers several endpoints:
Endpoint | Description |
---|---|
NLP | Semantic analysis of articles |
/v2/nlp/analyze | Semantic analysis of an article returning tags, entities, sentiment, etc. |
/v2/nlp/analyze/feedback | Feedback on a particular analysis |
Knowledgebase | Endpoints returning real-world information about tags and entities |
/v2/knowledgebase/details | Information about tags and entities |
/v2/knowledgebase/infoboxes | Information about tags and entities optimized for UI display |
/v2/knowledgebase/redirects | Replacements for deprecated knowledge base entities |
/v2/knowledgebase/search | Searching knowledge base for entities |
/v2/knowledgebase/stdforms | Standard forms of tags and entities in a particular language |
Editorial Tags | Configuration of customer-specific topic tags |
/v2/customize/editorial_tag/create | Creating a new editorial tag |
/v2/customize/editorial_tag/list | List of all existing editorial tags |
/v2/customize/editorial_tag/search | Searching for editorial tags by their name or ID |
/v2/customize/editorial_tag/{gkbId} | Get, update or delete a particular editorial tag |
Recommender | Endpoints recommending relevant articles and photos for articles |
/v2/photos | Supported photo banks |
/v2/photos/{dataset}/recommend | Recommend photos for an article |
/v2/photos/{dataset}/recommend/feedback | Feedback on a particular recommendation |
The Media API V2 endpoints accept and return the following request and response objects:
Endpoint | Type | Request | 200 Result |
---|---|---|---|
NLP | |||
/v2/nlp/analyze | POST | NlpRequest | Analysis (same as G3 response) |
/v2/nlp/analyze/feedback | POST | AnalyzeFeedback | |
Knowledgebase | |||
/v2/knowledgebase/details | POST | GkbItemsInfoRequest | Map[string, Details] |
/v2/knowledgebase/infoboxes | POST | GkbItemsInfoRequest | Map[string, LangValueInfoBox] |
/v2/knowledgebase/redirects | POST | GkbItemsRedirectsRequest | List[Redirects] |
/v2/knowledgebase/search | POST | GkbItemsSearchRequest | List[SearchResults] |
/v2/knowledgebase/stdforms | POST | GkbItemsStdFormRequest | Map[string, LangValueString] |
Editorial tags | |||
/v2/customize/editorial_tag/create | POST | EditorialTag | EditorialTag |
/v2/customize/editorial_tag/list | GET | EditorialTagListResponse | |
/v2/customize/editorial_tag/search | GET | EditorialTagSearchResponse | |
/v2/customize/editorial_tag/{gkbId} | GET | EditorialTag | |
/v2/customize/editorial_tag/{gkbId} | PUT | EditorialTag | EditorialTag |
/v2/customize/editorial_tag/{gkbId} | DELETE | ||
Recommender | |||
/v2/photos | GET | ||
/v2/photos/{dataset}/recommend | POST | PhotosRequest | PhotosRecommendation |
/v2/photos/{dataset}/recommend/feedback | POST | RecommendFeedback |
Request Objects
- Category
- ConstraintCategory
- ConstraintString
- ConstraintTag
- EditorialTag
- GkbItemsInfoRequest
- GkbItemsStdFormRequest
- NlpRequest
- ParaSpec
- PhotoConstraints
- PhotosRequest
- Recommendation
Response Objects
- Analysis
- AnalyzeFeedback
- AnalyzeFeedbackItem
- AnalyzeFeedbackSentiment
- Argument
- CharSpan
- Details
- EditorialTag
- EditorialTagListResponse
- EditorialTagSearchResponse
- Entity
- GkbProperty
- InfoBox
- Language
- LangValueInfoBox
- LangValueString
- Mention
- Paragraph
- PhotoData
- PhotosRecommendation
- PhotoTag
- RecommendFeedback
- RecommendFeedbackPhoto
- Relation
- Sentence
- Sentiment
- Support
- Tag
- TectoToken
- Token
- Vector