{"openapi":"3.0.1","info":{"title":"Geneea Media Assistant","version":"0.180.1"},"servers":[{"url":"https://media-api.geneea.com","description":"Generated server url"}],"security":[{"X-API-Key":[]}],"paths":{"/v2/customize/editorial_tag/{gkbId}":{"get":{"tags":["editorial-tags-controller"],"operationId":"retrieve","parameters":[{"name":"gkbId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditorialTag"}}}}}},"put":{"tags":["editorial-tags-controller"],"operationId":"update","parameters":[{"name":"gkbId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorialTag"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditorialTag"}}}}}},"delete":{"tags":["editorial-tags-controller"],"operationId":"delete","parameters":[{"name":"gkbId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK"}}}},"/v2/articles/{dataset}/{articleId}":{"get":{"tags":["article-matcher-controller"],"description":"Get existing article from the index","operationId":"getArticle","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}},{"name":"articleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Article"}}}}}},"put":{"tags":["article-matcher-controller"],"description":"Add new article to the index (or update existing article)","operationId":"putArticle","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}},{"name":"articleId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Article"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}},"delete":{"tags":["article-matcher-controller"],"description":"Delete existing article from the index","operationId":"deleteArticle","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}},{"name":"articleId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}}}}},"/v2/photos/{dataset}/recommend":{"post":{"tags":["photo-matcher-controller"],"operationId":"recommend","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PhotosRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhotosRecommendation"}}}}}}},"/v2/photos/{dataset}/recommend/feedback":{"post":{"tags":["photo-matcher-controller"],"operationId":"feedback","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendFeedback"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK"}}}},"/v2/nlp/analyze":{"post":{"tags":["nlp-controller"],"externalDocs":{"url":"https://api.geneea.com/#!/geneea-api-v3/analysisPost"},"operationId":"analyze","requestBody":{"description":"G3 request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NlpRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"G3 response","content":{"*/*":{"schema":{"type":"string","externalDocs":{"url":"https://api.geneea.com/#!/geneea-api-v3/analysisPost"}}}}}}}},"/v2/nlp/analyze/feedback":{"post":{"tags":["nlp-controller"],"operationId":"feedback_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyzeFeedback"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK"}}}},"/v2/nlp/analyze/batch":{"post":{"tags":["nlp-controller"],"externalDocs":{"url":"https://api.geneea.com/#!/geneea-api-v3/analysisBatch"},"operationId":"analyzeBatch","requestBody":{"description":"batch G3 request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NlpRequest"}}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"batch G3 response","content":{"*/*":{"schema":{"type":"string","externalDocs":{"url":"https://api.geneea.com/#!/geneea-api-v3/analysisBatch"}}}}}}}},"/v2/knowledgebase/stdforms":{"post":{"tags":["knowledgebase-controller"],"operationId":"stdforms","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GkbItemsStdFormRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LangValueString"}}}}}}}},"/v2/knowledgebase/search":{"post":{"tags":["knowledgebase-controller"],"operationId":"search","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GkbItemsSearchRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResults"}}}}}}},"/v2/knowledgebase/redirects":{"post":{"tags":["knowledgebase-controller"],"operationId":"redirects","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GkbItemsRedirectsRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Redirects"}}}}}}}},"/v2/knowledgebase/infoboxes":{"post":{"tags":["knowledgebase-controller"],"operationId":"infoBoxes","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GkbItemsInfoRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/LangValueInfoBox"}}}}}}}},"/v2/knowledgebase/details":{"post":{"tags":["knowledgebase-controller"],"operationId":"details","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GkbItemsInfoRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Details"}}}}}}}},"/v2/customize/editorial_tag/create":{"post":{"tags":["editorial-tags-controller"],"operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditorialTag"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditorialTag"}}}}}}},"/v2/articles/{dataset}/recommend":{"post":{"tags":["article-matcher-controller"],"description":"Get a recommendation for related articles","operationId":"recommend_1","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArticlesRequest"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ArticlesRecommendation"}}}}}}},"/v2/articles/{dataset}/recommend/feedback":{"post":{"tags":["article-matcher-controller"],"description":"Submit a feedback on the recommendation results","operationId":"feedback_2","parameters":[{"name":"dataset","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendFeedback"}}},"required":true},"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK"}}}},"/v2/photos":{"get":{"tags":["photo-matcher-controller"],"operationId":"datasets","responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/v2/customize/editorial_tag/search":{"get":{"tags":["editorial-tags-controller"],"operationId":"search_1","parameters":[{"name":"name","in":"query","description":"The name of the Tag","required":false,"schema":{"type":"string","description":"The name of the Tag"}},{"name":"externalId","in":"query","description":"The ID of the Tag in the external system","required":false,"schema":{"type":"string","description":"The ID of the Tag in the external system"}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditorialTagSearchResponse"}}}}}}},"/v2/customize/editorial_tag/list":{"get":{"tags":["editorial-tags-controller"],"operationId":"list","parameters":[{"name":"returnObjects","in":"query","description":"If true, the full Tag objects will be returned; otherwise, just GKB IDs are returned","required":false,"schema":{"type":"string","description":"If true, the full Tag objects will be returned; otherwise, just GKB IDs are returned"}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EditorialTagListResponse"}}}}}}},"/v2/billing/usage":{"get":{"tags":["billing-controller"],"description":"Usage reporting.","operationId":"usage","parameters":[{"name":"metric","in":"query","description":"Metric to get the usage for","required":false,"schema":{"type":"string","description":"Metric to get the usage for","enum":["nlp-analyze-requests"]}},{"name":"granularity","in":"query","description":"Granularity for the usage metric.","required":false,"schema":{"type":"string","description":"Granularity for the usage metric.","enum":["month","day"]}},{"name":"sinceDate","in":"query","description":"Time range start, date in ISO format, e.g. \"2025-01-01\".","required":false,"schema":{"type":"string","description":"Time range start, date in ISO format, e.g. \"2025-01-01\"."}},{"name":"untilDate","in":"query","description":"Time range end, date in ISO format, e.g. \"2025-12-31\".","required":false,"schema":{"type":"string","description":"Time range end, date in ISO format, e.g. \"2025-12-31\"."}}],"responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}}}},"/v2/articles":{"get":{"tags":["article-matcher-controller"],"description":"Get available article datasets","operationId":"datasets_1","responses":{"500":{"description":"Internal Server Error"},"400":{"description":"Bad Request"},"404":{"description":"Not Found","content":{}},"403":{"description":"Forbidden","content":{}},"413":{"description":"Payload Too Large","content":{}},"429":{"description":"Too Many Requests","content":{}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"type":"string"}}}}}}}}},"components":{"schemas":{"EditorialTag":{"required":["forbidden","gkbId","name"],"type":"object","properties":{"gkbId":{"type":"string","description":"Unique identifier of the Tag in Geneea knowledge-base"},"name":{"type":"string","description":"The name of the Tag, used as default standard form"},"externalId":{"type":"string","description":"The ID of the Tag in the external system"},"forbidden":{"type":"boolean","description":"If true, the Tag will be ignored"},"stdForms":{"type":"object","additionalProperties":{"type":"string","description":"The Tag standard forms by language"},"description":"The Tag standard forms by language"},"descriptions":{"type":"object","additionalProperties":{"type":"string","description":"The Tag descriptions by language"},"description":"The Tag descriptions by language"},"categories":{"type":"array","description":"Any categories that the Tag belongs to","items":{"type":"string","description":"Any categories that the Tag belongs to"}}},"description":"Editorial Tag"},"Article":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the article."},"title":{"type":"string","description":"The title or subject of the article, when available; mutually exclusive with the 'paraSpecs' parameter"},"lead":{"type":"string","description":"The lead or abstract of the article, when available; mutually exclusive with the 'paraSpecs' parameter"},"text":{"type":"string","description":"The main text or body of the article; mutually exclusive with the 'paraSpecs' parameter"},"paraSpecs":{"type":"array","description":"The article paragraphs; mutually exclusive with 'title', 'lead', and 'text' parameters","items":{"$ref":"#/components/schemas/ParaSpec"}},"language":{"type":"string","description":"The language of the article as ISO 639-1"},"publishDate":{"type":"string","description":"Date when the article was published, in ISO format, e.g. \"2025-01-01T12:00:00Z\""},"categories":{"type":"array","description":"The categories of the article","items":{"$ref":"#/components/schemas/Category"}},"recommendation":{"$ref":"#/components/schemas/Recommendation"},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Any additional metadata for the article"},"description":"Any additional metadata for the article"}}},"Category":{"required":["code","taxonomy"],"type":"object","properties":{"taxonomy":{"type":"string","description":"The category taxonomy","enum":["SubjectCode","MediaTopic","Custom"]},"code":{"type":"string","description":"The name of the category"}},"description":"A document category specification"},"ParaSpec":{"required":["text","type"],"type":"object","properties":{"type":{"type":"string","description":"The paragraph type (e.g. title, lead, body, heading)"},"text":{"type":"string","description":"The text of the document paragraph"}},"description":"A document paragraph specification"},"Recommendation":{"required":["published","status"],"type":"object","properties":{"published":{"type":"boolean","description":"Document publication flag"},"status":{"type":"string","description":"Recommendation status","enum":["ALWAYS","NEVER","EXPIRE_DATE","NOT_SET"]},"url":{"type":"string","description":"URL of the document"},"imageUrl":{"type":"string","description":"URL of the main image for the document"},"publishDate":{"type":"string","description":"Publish date and time for the document in ISO format"},"expireDate":{"type":"string","description":"Expiration date and time for the recommendation in ISO format"},"type":{"type":"string","description":"Document type, values \"article\", \"gallery\" etc."},"importance":{"type":"integer","description":"Document importance, greater values mean greater importance","format":"int32"},"breakingNews":{"type":"boolean","description":"Document breaking-news flag"}},"description":"Recommendation info for the document"},"MessageResponse":{"required":["message"],"type":"object","properties":{"message":{"type":"string"},"others":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"ConstraintCategory":{"type":"object","properties":{"anyOf":{"type":"array","description":"The photo must match at least one criteria.","items":{"$ref":"#/components/schemas/Category"}},"allOf":{"type":"array","description":"The photo must match all the criteria.","items":{"$ref":"#/components/schemas/Category"}},"noneOf":{"type":"array","description":"The photo must not match any criteria.","items":{"$ref":"#/components/schemas/Category"}},"ignore":{"type":"array","description":"Turns off the criteria that could otherwise be determined and applied during the recommendation process.","items":{"$ref":"#/components/schemas/Category"}}},"description":"Category constraints."},"ConstraintString":{"type":"object","properties":{"anyOf":{"type":"array","description":"The photo must match at least one criteria.","items":{"type":"string","description":"The photo must match at least one criteria."}},"allOf":{"type":"array","description":"The photo must match all the criteria.","items":{"type":"string","description":"The photo must match all the criteria."}},"noneOf":{"type":"array","description":"The photo must not match any criteria.","items":{"type":"string","description":"The photo must not match any criteria."}},"ignore":{"type":"array","description":"Turns off the criteria that could otherwise be determined and applied during the recommendation process.","items":{"type":"string","description":"Turns off the criteria that could otherwise be determined and applied during the recommendation process."}}},"description":"Orientation constraints."},"ConstraintTag":{"type":"object","properties":{"anyOf":{"type":"array","description":"The photo must match at least one criteria.","items":{"$ref":"#/components/schemas/Tag"}},"allOf":{"type":"array","description":"The photo must match all the criteria.","items":{"$ref":"#/components/schemas/Tag"}},"noneOf":{"type":"array","description":"The photo must not match any criteria.","items":{"$ref":"#/components/schemas/Tag"}},"ignore":{"type":"array","description":"Turns off the criteria that could otherwise be determined and applied during the recommendation process.","items":{"$ref":"#/components/schemas/Tag"}}},"description":"Tag constraints."},"PhotoConstraints":{"type":"object","properties":{"likePhotoId":{"type":"string","description":"Id of a previously retrieved photo; requires a cursor to results with that photo."},"dateBefore":{"type":"string","description":"The photo 'createdAt/updatedAt' properties timestamp constraint. Photos with their 'createdAt/updatedAt' timestamp before this timestamp constraint will be recommended. (in format YYYY-MM-DD)"},"dateAfter":{"type":"string","description":"The photo 'createdAt/updatedAt' properties timestamp constraint. Photos with their 'createdAt/updatedAt' timestamp after this timestamp constraint will be recommended. (in format YYYY-MM-DD)"},"tags":{"$ref":"#/components/schemas/ConstraintTag"},"category":{"$ref":"#/components/schemas/ConstraintCategory"},"orientation":{"$ref":"#/components/schemas/ConstraintString"}},"description":"The constraints and restrictions on the photo properties to narrow down the photos recommendation results."},"PhotosRequest":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the article."},"title":{"type":"string","description":"The title or subject of the article, when available; mutually exclusive with the 'paraSpecs' parameter"},"lead":{"type":"string","description":"The lead or abstract of the article, when available; mutually exclusive with the 'paraSpecs' parameter"},"text":{"type":"string","description":"The main text or body of the article; mutually exclusive with the 'paraSpecs' parameter"},"paraSpecs":{"type":"array","description":"The article paragraphs; mutually exclusive with 'title', 'lead' and 'text' parameters","items":{"$ref":"#/components/schemas/ParaSpec"}},"categories":{"type":"array","description":"The categories of the article","items":{"$ref":"#/components/schemas/Category"}},"referenceDate":{"type":"string","description":"Date to be used for the analysis as a reference; values: \"NOW\" or in format YYYY-MM-DD"},"language":{"type":"string","description":"The language of the article"},"presentationLanguage":{"type":"string","description":"The presentation language of the results"},"recommendationCount":{"type":"integer","description":"The number of photographs to recommend.","format":"int32"},"altPhotosCount":{"type":"integer","description":"Maximum number of photo alternatives to return per recommended photograph.","format":"int32"},"constraints":{"$ref":"#/components/schemas/PhotoConstraints"},"returnAltPhotos":{"type":"boolean","description":"Return photo alternatives, when available, for the recommended photographs.","default":false},"returnObjects":{"type":"boolean","description":"Return PhotoData objects in addition to the photo IDs for the recommended photographs.","default":false},"returnObjectFields":{"type":"array","description":"The list of photo fields that should be returned in the 'PhototData' object.\nThis is ignored if 'returnObjects' is not set to true. The photo ID field is always returned, even if it is not mentioned in 'returnObjectFields'. If 'returnObjectFields' is not specified then all photo fields are returned.","items":{"type":"string","description":"The list of photo fields that should be returned in the 'PhototData' object.\nThis is ignored if 'returnObjects' is not set to true. The photo ID field is always returned, even if it is not mentioned in 'returnObjectFields'. If 'returnObjectFields' is not specified then all photo fields are returned."}},"cursor":{"type":"string","description":"Enables pagination. If cursor parameter is missing the pagination is disabled. To enable pagination set the value to '*'. To retrieve the next page use nextCursor from the previous result. Make sure to not change other parameters in pagination request."}},"description":"Assistant V2 photo recommendation request."},"Tag":{"required":["value"],"type":"object","properties":{"type":{"type":"string","description":"The type of the tag, e.g.: 'Geneea', 'Wikidata', 'text'","default":"Geneea"},"value":{"type":"string","description":"The value of the tag","example":"G213"}},"description":"Turns off the criteria that could otherwise be determined and applied during the recommendation process."},"PhotoData":{"required":["categories","id"],"type":"object","properties":{"id":{"type":"string","description":"ID of the photograph."},"categories":{"type":"array","description":"Categories of the photograph.","items":{"$ref":"#/components/schemas/Category"}}},"description":"Photo data. Not listed fields are documented in external documentation: https://geneeamatcherapi2.docs.apiary.io/#reference/photographs/photograph/recommend-photographs","externalDocs":{"url":"https://geneeamatcherapi2.docs.apiary.io/#reference/photographs/photograph/recommend-photographs"}},"PhotoTag":{"required":["description","score","subType","type","value"],"type":"object","properties":{"type":{"type":"string","description":"Type of the tag.","example":"Geneea"},"value":{"type":"string","description":"Value of the tag.","example":"G213"},"subType":{"type":"string","description":"Subtype of the tag.","example":"location"},"description":{"type":"string","description":"Description of the tag.","example":"Czech Republic"},"score":{"type":"number","description":"Score of the tag, calculated based on all returned tags.","format":"double","example":32.6}},"description":"Tag associated with the photo."},"PhotosRecommendation":{"required":["id","photosIds","referenceKey","tags"],"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the article from the photos recommendation request."},"referenceKey":{"type":"string","description":"Unique ID of this recommendation."},"photosIds":{"type":"array","description":"Ids of the recommended photos.","items":{"type":"string","description":"Ids of the recommended photos."}},"altPhotoIds":{"type":"object","additionalProperties":{"type":"array","description":"Ids of photo alternatives for the recommended photographs by their ID. This field is returned only if returnAltPhotos in the recommendation request is set to true.","items":{"type":"string","description":"Ids of photo alternatives for the recommended photographs by their ID. This field is returned only if returnAltPhotos in the recommendation request is set to true."}},"description":"Ids of photo alternatives for the recommended photographs by their ID. This field is returned only if returnAltPhotos in the recommendation request is set to true."},"photos":{"type":"array","description":"The PhotoData objects representing the recommended photographs. This field is returned only if returnObjects in the recommendation request is set to true. Please use the request's returnObjectFields to specify the PhotoData object fields that you really need. This will reduce the size of PhotoData objects returned here.","items":{"$ref":"#/components/schemas/PhotoData"}},"altPhotos":{"type":"object","additionalProperties":{"type":"array","description":"The PhotoData objects of photo alternatives for the recommended photographs by their ID. This field is returned only if both returnAltPhotos and returnObjects in the recommendation request are set to true.","items":{"$ref":"#/components/schemas/PhotoData"}},"description":"The PhotoData objects of photo alternatives for the recommended photographs by their ID. This field is returned only if both returnAltPhotos and returnObjects in the recommendation request are set to true."},"tags":{"type":"array","description":"Tags associated with the recommended photos. These tags can be used for further refining of the recommendation results.","items":{"$ref":"#/components/schemas/PhotoTag"}},"nextCursor":{"type":"string","description":"Cursor for retrieving the next page. Available when pagination is enabled. For more details see cursor in the Request."}},"description":"Recommendation response."},"RecommendFeedback":{"required":["docId"],"type":"object","properties":{"docId":{"type":"string","description":"Unique identifier of the document"},"referenceKey":{"type":"string","description":"A reference key to identify a particular recommendation result"},"photos":{"type":"array","description":"Feedback on the results for recommended Photos","items":{"$ref":"#/components/schemas/RecommendFeedbackItem"}},"articles":{"type":"array","description":"Feedback on the results for recommended Articles","items":{"$ref":"#/components/schemas/RecommendFeedbackItem"}}},"description":"A feedback for the results from the recommendation API"},"RecommendFeedbackItem":{"required":["id","status"],"type":"object","properties":{"id":{"type":"string","description":"ID for the Photo or Article"},"status":{"type":"string","description":"The feedback status can be one of the following:\n- \"accepted-actively\" = The value has been explicitly accepted as correct.\n- \"accepted-passively\" = The value has been accepted, but not explicitly.\n- \"rejected-actively\" = The value has been explicitly rejected (but no reason was specified).\n- \"rejected-actively-wrong\" = The value has been explicitly rejected because the document does not mention\n  the concept at all, e.g. it may mention a different person or place with the same name.\n- \"rejected-actively-marginal\" = The value has been explicitly rejected because despite being correct,\n  is not relevant enough to be selected, e.g. it is mentioned only marginally.\n- \"rejected-passively\" = The value has been rejected but not explicitly.\n- \"expected\" = The correct value that should have been returned but wasn't.\n- \"blocked\" = The value is not acceptable (it is always rejected), regardless of the document.\n"},"author":{"type":"string","description":"Author (or source) of the feedback; optional"},"comment":{"type":"string","description":"Any additional comment or description; optional"}},"description":"Feedback for a particular recommended Photo or Article"},"NlpRequest":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document"},"title":{"type":"string","description":"The title or subject of the document, when available; mutually exclusive with the 'paraSpecs' parameter"},"lead":{"type":"string","description":"The lead or abstract of the document, when available; mutually exclusive with the 'paraSpecs' parameter"},"text":{"type":"string","description":"The main text or body of the document; mutually exclusive with the 'paraSpecs' parameter"},"paraSpecs":{"type":"array","description":"The document paragraphs; mutually exclusive with 'title', 'lead' and 'text' parameters","items":{"$ref":"#/components/schemas/ParaSpec"}},"domicile":{"type":"string","description":"A domicile indicating the origin location of the document"},"analyses":{"type":"array","description":"[option] What analysis to return. Default: all","items":{"type":"string","description":"[option] What analysis to return. Default: all","enum":["all","entities","tags","relations","sentiment","language"]},"enum":["all","entities","tags","relations","sentiment","language"]},"language":{"type":"string","description":"[option] The language of the document as ISO 639-1; auto-detection will be used if omitted"},"langDetectPrior":{"type":"string","description":"[option] The language detection prior; e.g. 'de,en'"},"presentationLanguage":{"type":"string","description":"[option] The presentation language of the results"},"categories":{"type":"array","description":"[option] The categories of the article","items":{"$ref":"#/components/schemas/Category"}},"referenceDate":{"type":"string","description":"[option] Date to be used for the analysis as a reference, optionally with time; values: \"NOW\" or in ISO format"},"returnMentions":{"type":"boolean","description":"[option] Should entity/tag/relation mentions be returned? Default: false"},"returnItemSentiment":{"type":"boolean","description":"[option] Should entity/mention/tag/relation etc. sentiment be returned? Default: false"},"returnGkbProperties":{"type":"boolean","description":"[option] Should entity/tag GKB properties be returned? Default: false"},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Any additional metadata for the document, e.g. domicile or URL"},"description":"Any additional metadata for the document, e.g. domicile or URL"},"recommendation":{"$ref":"#/components/schemas/Recommendation"}},"description":"NLP request for Media Assistant v2, based on Geneea API v3"},"AnalyzeFeedback":{"required":["docId"],"type":"object","properties":{"docId":{"type":"string","description":"Unique identifier of the document"},"referenceKey":{"type":"string","description":"A reference key to identify a particular NLP analysis result (i.e. the value from '.metadata.referenceKey')"},"tags":{"type":"array","description":"Feedback on the results for Tags","items":{"$ref":"#/components/schemas/AnalyzeFeedbackItem"}},"entities":{"type":"array","description":"Feedback on the results for Entities","items":{"$ref":"#/components/schemas/AnalyzeFeedbackItem"}},"docSentiment":{"$ref":"#/components/schemas/AnalyzeFeedbackSentiment"}},"description":"A feedback for the results from the NLP analyze API"},"AnalyzeFeedbackItem":{"required":["status"],"type":"object","properties":{"gkbId":{"type":"string","description":"GKB ID for the Entity or Tag"},"stdForm":{"type":"string","description":"Standard form for the Entity or Tag"},"status":{"type":"string","description":"The feedback status can be one of the following:\n- \"accepted-actively\" = The value has been explicitly accepted as correct.\n- \"accepted-passively\" = The value has been accepted, but not explicitly.\n- \"rejected-actively\" = The value has been explicitly rejected (but no reason was specified).\n- \"rejected-actively-wrong\" = The value has been explicitly rejected because the document does not mention\n  the concept at all, e.g. it may mention a different person or place with the same name.\n- \"rejected-actively-marginal\" = The value has been explicitly rejected because despite being correct,\n  is not relevant enough to be selected, e.g. it is mentioned only marginally.\n- \"rejected-passively\" = The value has been rejected but not explicitly.\n- \"expected\" = The correct value that should have been returned but wasn't.\n- \"blocked\" = The value is not acceptable (it is always rejected), regardless of the document.\n"},"author":{"type":"string","description":"Author (or source) of the feedback; optional"},"comment":{"type":"string","description":"Any additional comment or description; optional"}},"description":"Feedback for a particular Entity or Tag"},"AnalyzeFeedbackSentiment":{"required":["label","status"],"type":"object","properties":{"label":{"type":"string","description":"The sentiment label, e.g. 'positive' or 'negative'"},"status":{"type":"string","description":"The feedback status can be one of the following:\n- \"accepted-actively\" = The value has been explicitly accepted as correct.\n- \"accepted-passively\" = The value has been accepted, but not explicitly.\n- \"rejected-actively\" = The value has been explicitly rejected (but no reason was specified).\n- \"rejected-actively-wrong\" = The value has been explicitly rejected because the document does not mention\n  the concept at all, e.g. it may mention a different person or place with the same name.\n- \"rejected-actively-marginal\" = The value has been explicitly rejected because despite being correct,\n  is not relevant enough to be selected, e.g. it is mentioned only marginally.\n- \"rejected-passively\" = The value has been rejected but not explicitly.\n- \"expected\" = The correct value that should have been returned but wasn't.\n- \"blocked\" = The value is not acceptable (it is always rejected), regardless of the document.\n"},"author":{"type":"string","description":"Author (or source) of the feedback; optional"},"comment":{"type":"string","description":"Any additional comment or description; optional"}},"description":"Feedback for sentiment analysis"},"GkbItemsStdFormRequest":{"required":["ids","language"],"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"externalSource":{"type":"string"}}},"LangValueString":{"required":["language","value"],"type":"object","properties":{"value":{"type":"string"},"language":{"type":"string"}}},"GkbItemsSearchRequest":{"required":["fallbackLanguages","language","query"],"type":"object","properties":{"query":{"type":"string"},"language":{"type":"string"},"fallbackLanguages":{"type":"array","items":{"type":"string"}}}},"Details":{"required":["description","externalIds","externalLinks","gkbId","stdForm","subtypes","type"],"type":"object","properties":{"gkbId":{"type":"string"},"stdForm":{"$ref":"#/components/schemas/LangValueString"},"description":{"$ref":"#/components/schemas/LangValueString"},"type":{"type":"string"},"subtypes":{"type":"array","items":{"type":"string"}},"externalIds":{"type":"object","additionalProperties":{"type":"string"}},"externalLinks":{"type":"object","additionalProperties":{"type":"string"}}}},"SearchResults":{"required":["hits","itemDetails","query"],"type":"object","properties":{"query":{"type":"string"},"hits":{"type":"integer","format":"int32"},"itemDetails":{"type":"array","items":{"$ref":"#/components/schemas/Details"}}}},"GkbItemsRedirectsRequest":{"required":["gkbIds"],"type":"object","properties":{"gkbIds":{"type":"array","items":{"type":"string"}}}},"Redirects":{"required":["replaces","status"],"type":"object","properties":{"status":{"type":"string"},"replacedBy":{"type":"string"},"replaces":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"GkbItemsInfoRequest":{"required":["fallbackLanguages","ids","language"],"type":"object","properties":{"ids":{"type":"array","items":{"type":"string"}},"language":{"type":"string"},"fallbackLanguages":{"type":"array","items":{"type":"string"}},"externalSource":{"type":"string"}}},"InfoBox":{"required":["body","footer","header","title"],"type":"object","properties":{"title":{"type":"string"},"header":{"type":"string"},"body":{"type":"string"},"footer":{"type":"object","additionalProperties":{"type":"string"}}}},"LangValueInfoBox":{"required":["language","value"],"type":"object","properties":{"value":{"$ref":"#/components/schemas/InfoBox"},"language":{"type":"string"}}},"ArticleConstraints":{"type":"object","properties":{"dateStartAt":{"type":"string","description":"A lower-bound for the 'publishDate' of the recommended articles, in ISO format."},"dateEndAt":{"type":"string","description":"A upper-bound for the 'publishDate' of the recommended articles, in ISO format."},"categoriesAnyOf":{"type":"array","description":"At least one value has to match the 'categories' of the recommended articles.","items":{"$ref":"#/components/schemas/Category"}},"categoriesNoneOf":{"type":"array","description":"None of the values can match the 'categories' of the recommended articles.","items":{"$ref":"#/components/schemas/Category"}}},"description":"The constraints on the article properties to narrow down the recommendation results."},"ArticlesRequest":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the article."},"title":{"type":"string","description":"The title or subject of the article, when available; mutually exclusive with the 'paraSpecs' parameter"},"lead":{"type":"string","description":"The lead or abstract of the article, when available; mutually exclusive with the 'paraSpecs' parameter"},"text":{"type":"string","description":"The main text or body of the article; mutually exclusive with the 'paraSpecs' parameter"},"paraSpecs":{"type":"array","description":"The article paragraphs; mutually exclusive with 'title', 'lead', and 'text' parameters","items":{"$ref":"#/components/schemas/ParaSpec"}},"language":{"type":"string","description":"The language of the article as ISO 639-1"},"publishDate":{"type":"string","description":"Date when the article was published, in ISO format, e.g. \"2025-01-01T12:00:00Z\""},"categories":{"type":"array","description":"The categories of the article","items":{"$ref":"#/components/schemas/Category"}},"recommendationCount":{"type":"integer","description":"The number of articles to recommend.","format":"int32"},"constraints":{"$ref":"#/components/schemas/ArticleConstraints"},"returnObjects":{"type":"boolean","description":"Return article objects in addition to the article IDs in the recommendation results."},"returnObjectFields":{"type":"array","description":"The list of article fields that should be returned in the article object.\nThis is ignored if 'returnObjects' is not set to true. The article ID field is always returned, even if it is not mentioned in 'returnObjectFields'. If 'returnObjectFields' is not specified then all article fields are returned.","items":{"type":"string","description":"The list of article fields that should be returned in the article object.\nThis is ignored if 'returnObjects' is not set to true. The article ID field is always returned, even if it is not mentioned in 'returnObjectFields'. If 'returnObjectFields' is not specified then all article fields are returned."}}},"description":"Assistant V2 article recommendation request."},"ArticlesRecommendation":{"required":["articleIds","id","referenceKey"],"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the article from the article recommendation request."},"referenceKey":{"type":"string","description":"Unique ID of this recommendation."},"articleIds":{"type":"array","description":"Ids of the recommended articles.","items":{"type":"string","description":"Ids of the recommended articles."}},"articles":{"type":"array","description":"The article objects representing the recommended articles.\nThis field is returned only if 'returnObjects' in the recommendation request is set to true. Please use the request's 'returnObjectFields' to specify the article object fields that you really need. This will reduce the size of article objects returned here.","items":{"$ref":"#/components/schemas/Article"}}},"description":"Recommendation response."},"EditorialTagSearchResponse":{"required":["foundTags"],"type":"object","properties":{"name":{"type":"string","description":"The name of the Tag"},"externalId":{"type":"string","description":"The ID of the Tag in the external system"},"foundTags":{"type":"array","description":"Matching Tags, may be empty","items":{"$ref":"#/components/schemas/EditorialTag"}}},"description":"Response for Editorial Tag search"},"EditorialTagListResponse":{"required":["gkbIds"],"type":"object","properties":{"gkbIds":{"type":"array","description":"List of GKB IDs of the Tags","items":{"type":"string","description":"List of GKB IDs of the Tags"}},"tags":{"type":"array","description":"List of Tag objects, if requested","items":{"$ref":"#/components/schemas/EditorialTag"}}},"description":"Response for listing Editorial Tags"},"UsageDetail":{"required":["period","usage"],"type":"object","properties":{"period":{"type":"string","description":"A period, e.g. \"2025-01-01\" for day, and \"2025-01\" for month."},"usage":{"type":"integer","description":"A usage for the period.","format":"int64"}},"description":"Usage by period."},"UsageResponse":{"required":["granularity","metric","sinceDate","totalUsage","untilDate","usageByPeriod"],"type":"object","properties":{"metric":{"type":"string","description":"Metric to get the usage for","enum":["nlp-analyze-requests"]},"granularity":{"type":"string","description":"Granularity for the usage metric.","enum":["month","day"]},"sinceDate":{"type":"string","description":"Time range start, date in ISO format, e.g. \"2025-01-01\"."},"untilDate":{"type":"string","description":"Time range end, date in ISO format, e.g. \"2025-12-31\"."},"totalUsage":{"type":"integer","description":"A total usage for the whole time range.","format":"int64"},"usageByPeriod":{"type":"array","description":"Usage for each time period.","items":{"$ref":"#/components/schemas/UsageDetail"}}},"description":"A response with the usage report."}},"securitySchemes":{"X-API-Key":{"type":"apiKey","name":"X-API-Key","in":"header","scheme":"X-API-Key"}}}}