{"openapi":"3.1.0","info":{"title":"🥥 ORKG-Ask API","version":"1.17.2"},"paths":{"/llm/extract/item/values":{"get":{"tags":["Large Language Models"],"summary":"Extract Item Values","description":"Extracts the properties with their corresponding values from the given item.","operationId":"extract_item_values_llm_extract_item_values_get","parameters":[{"name":"properties","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"The properties to extract from the item","title":"Properties"},"description":"The properties to extract from the item"},{"name":"item_id","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"description":"The item ID to extract the values from","title":"Item Id"},"description":"The item ID to extract the values from"},{"name":"collection_item_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The custom collection item ID to extract the values from","title":"Collection Item Id"},"description":"The custom collection item ID to extract the values from"},{"name":"invalidate_cache","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to invalidate the cache for the item","default":false,"title":"Invalidate Cache"},"description":"Whether to invalidate the cache for the item"},{"name":"response_language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The language of the response. Should be one of the following: en, de, es, fr, it, pt, nl, ru, ja, ar, fa, tr, ko, zh, hi, vi, id","title":"Response Language"},"description":"The language of the response. Should be one of the following: en, de, es, fr, it, pt, nl, ru, ja, ar, fa, tr, ko, zh, hi, vi, id"},{"name":"seed","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The seed to use during extraction","title":"Seed"},"description":"The seed to use during extraction"},{"name":"reproducibility","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the generation parameters and prompts for the response","default":false,"title":"Reproducibility"},"description":"Whether to include the generation parameters and prompts for the response"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractItemValuesFromPropertiesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/llm/synthesize/items/abstracts":{"get":{"tags":["Large Language Models"],"summary":"Synthesize Abstracts For Question","description":"Synthesizes a citable answer for a given research question from the abstracts of the given items.","operationId":"synthesize_abstracts_for_question_llm_synthesize_items_abstracts_get","parameters":[{"name":"question","in":"query","required":true,"schema":{"type":"string","description":"The question to synthesize the abstracts for","title":"Question"},"description":"The question to synthesize the abstracts for"},{"name":"item_ids","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"description":"The item ID to use during synthesis","title":"Item Ids"},"description":"The item ID to use during synthesis"},{"name":"collection_item_ids","in":"query","required":false,"schema":{"type":"array","items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"description":"The custom collection item IDs to use during synthesis","title":"Collection Item Ids"},"description":"The custom collection item IDs to use during synthesis"},{"name":"invalidate_cache","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to invalidate the cache for the item","default":false,"title":"Invalidate Cache"},"description":"Whether to invalidate the cache for the item"},{"name":"response_language","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The language of the response. Should be one of the following: en, de, es, fr, it, pt, nl, ru, ja, ar, fa, tr, ko, zh, hi, vi, id","title":"Response Language"},"description":"The language of the response. Should be one of the following: en, de, es, fr, it, pt, nl, ru, ja, ar, fa, tr, ko, zh, hi, vi, id"},{"name":"seed","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The seed to use during extraction","title":"Seed"},"description":"The seed to use during extraction"},{"name":"reproducibility","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to include the generation parameters and prompts for the response","default":false,"title":"Reproducibility"},"description":"Whether to include the generation parameters and prompts for the response"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynthesisAnswerOfQuestionFromAbstractsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/llm/generate":{"post":{"tags":["Large Language Models"],"summary":"Generate Llm","operationId":"generate_llm_llm_generate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMGenerateRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMRawResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/llm/chat/completions":{"post":{"tags":["Large Language Models"],"summary":"Chat Completions Llm","operationId":"chat_completions_llm_llm_chat_completions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMChatRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMRawResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/add":{"post":{"tags":["Semantic Neural Search"],"summary":"Index New Document","description":"Index a new document in the vector database.","operationId":"index_new_document_index_add_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantDictResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/add/bulk":{"post":{"tags":["Semantic Neural Search"],"summary":"Bulk Index Documents","description":"Index a list of documents in the vector database.","operationId":"bulk_index_documents_index_add_bulk_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkIndexRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/search":{"get":{"tags":["Semantic Neural Search"],"summary":"Semantic Search","description":"Searches for similar documents using semantic vector search.\nScholarly documents are indexed with metadata and embeddings, allowing for efficient retrieval.","operationId":"semantic_search_index_search_get","parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"The text to search for","title":"Query"},"description":"The text to search for"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"exclusiveMinimum":0,"description":"The maximum number of documents to return","default":10,"title":"Limit"},"description":"The maximum number of documents to return"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"The offset to start fetching documents from","title":"Offset"},"description":"The offset to start fetching documents from"},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The criteria to filter the search results","title":"Filter"},"description":"The criteria to filter the search results","examples":{"year equal to":{"summary":"year equal to a specific value","description":"The `year` field equal to a specific value here `2023`","value":"year = 2023"},"year greater than":{"summary":"year greater than a specific value","description":"The `year` field greater than a specific value here `2013`","value":"year > 2013"},"citations in range":{"summary":"citations in a specific range","description":"The `citations` field in a specific range here `10` to `100`","value":"citations > 10, <=100"},"title like":{"summary":"title like a specific value","description":"The `title` field like a specific value here `machine learning`.\n         This will use full text search index to find the documents.","value":"title LIKE \"machine learning\""},"language in list":{"summary":"language in a specific list","description":"The `language` field in a specific list here `en` or `fr`","value":"language IN [\"en\", \"fr\"]"},"full text is null":{"summary":"full text is null","description":"The `full_text` field is null","value":"IS_NULL(full_text)"},"complex filter":{"summary":"complex filter","description":"A complex filter with multiple fields.\n         You can use `AND`, `OR` and `NOT` operators to combine the filters.\n          Here `year` not equal to `2013` and `issbn` not in a specific list and `title` like a specific value","value":"(year != 2013 OR issbn NOT IN [\"1231313\", \"1231355444\"]) AND title LIKE \"machine learning\""}}},{"name":"focus","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The sources to search from","title":"Focus"},"description":"The sources to search from"},{"name":"fields","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which fields to return in the response, comma-separated. null for all fields","title":"Fields"},"description":"Which fields to return in the response, comma-separated. null for all fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantPagedDocumentsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/get/{document_id}":{"get":{"tags":["Semantic Neural Search"],"summary":"Retrieve Document","description":"Get a single document from the vector store via its ID","operationId":"retrieve_document_index_get__document_id__get","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"fields","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which fields to return in the response, comma-separated. null for all fields","title":"Fields"},"description":"Which fields to return in the response, comma-separated. null for all fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantSingleDocumentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/explore":{"get":{"tags":["Semantic Neural Search"],"summary":"Explore Documents","description":"Explore documents from the vector store using filters.\nThe filters only address the metadata like year, authors, etc..","operationId":"explore_documents_index_explore_get","parameters":[{"name":"filter","in":"query","required":true,"schema":{"type":"string","description":"The criteria to filter the search results","title":"Filter"},"description":"The criteria to filter the search results","examples":{"year equal to":{"summary":"year equal to a specific value","description":"The `year` field equal to a specific value here `2023`","value":"year = 2023"},"year greater than":{"summary":"year greater than a specific value","description":"The `year` field greater than a specific value here `2013`","value":"year > 2013"},"citations in range":{"summary":"citations in a specific range","description":"The `citations` field in a specific range here `10` to `100`","value":"citations > 10, <=100"},"title like":{"summary":"title like a specific value","description":"The `title` field like a specific value here `machine learning`.\n         This will use full text search index to find the documents.","value":"title LIKE \"machine learning\""},"language in list":{"summary":"language in a specific list","description":"The `language` field in a specific list here `en` or `fr`","value":"language IN [\"en\", \"fr\"]"},"full text is null":{"summary":"full text is null","description":"The `full_text` field is null","value":"IS_NULL(full_text)"},"complex filter":{"summary":"complex filter","description":"A complex filter with multiple fields.\n         You can use `AND`, `OR` and `NOT` operators to combine the filters.\n          Here `year` not equal to `2013` and `issbn` not in a specific list and `title` like a specific value","value":"(year != 2013 OR issbn NOT IN [\"1231313\", \"1231355444\"]) AND title LIKE \"machine learning\""}}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"exclusiveMinimum":0,"description":"The maximum number of documents to return","default":10,"title":"Limit"},"description":"The maximum number of documents to return"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"The offset to start fetching documents from","title":"Offset"},"description":"The offset to start fetching documents from"},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The payload field to order by","title":"Order By"},"description":"The payload field to order by"},{"name":"focus","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The sources to explore documents from","title":"Focus"},"description":"The sources to explore documents from"},{"name":"fields","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which fields to return in the response, comma-separated. null for all fields","title":"Fields"},"description":"Which fields to return in the response, comma-separated. null for all fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantPagedDocumentsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/recommend":{"get":{"tags":["Semantic Neural Search"],"summary":"Recommend Documents","description":"Recommend documents from the vector store based on a list of document IDs.\nOther metadata filters can be applied to the search.","operationId":"recommend_documents_index_recommend_get","parameters":[{"name":"document_ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"The document IDs to be used for recommendations","title":"Document Ids"},"description":"The document IDs to be used for recommendations"},{"name":"avoid_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The document IDs to be avoided for recommendations","title":"Avoid Ids"},"description":"The document IDs to be avoided for recommendations"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"exclusiveMinimum":0,"description":"The maximum number of documents to return","default":10,"title":"Limit"},"description":"The maximum number of documents to return"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"The offset to start fetching documents from","title":"Offset"},"description":"The offset to start fetching documents from"},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The criteria to filter the search results","title":"Filter"},"description":"The criteria to filter the search results","examples":{"year equal to":{"summary":"year equal to a specific value","description":"The `year` field equal to a specific value here `2023`","value":"year = 2023"},"year greater than":{"summary":"year greater than a specific value","description":"The `year` field greater than a specific value here `2013`","value":"year > 2013"},"citations in range":{"summary":"citations in a specific range","description":"The `citations` field in a specific range here `10` to `100`","value":"citations > 10, <=100"},"title like":{"summary":"title like a specific value","description":"The `title` field like a specific value here `machine learning`.\n         This will use full text search index to find the documents.","value":"title LIKE \"machine learning\""},"language in list":{"summary":"language in a specific list","description":"The `language` field in a specific list here `en` or `fr`","value":"language IN [\"en\", \"fr\"]"},"full text is null":{"summary":"full text is null","description":"The `full_text` field is null","value":"IS_NULL(full_text)"},"complex filter":{"summary":"complex filter","description":"A complex filter with multiple fields.\n         You can use `AND`, `OR` and `NOT` operators to combine the filters.\n          Here `year` not equal to `2013` and `issbn` not in a specific list and `title` like a specific value","value":"(year != 2013 OR issbn NOT IN [\"1231313\", \"1231355444\"]) AND title LIKE \"machine learning\""}}},{"name":"fields","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Which fields to return in the response, comma-separated. null for all fields","title":"Fields"},"description":"Which fields to return in the response, comma-separated. null for all fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantListDocumentsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/count":{"get":{"tags":["Semantic Neural Search"],"summary":"Count Documents","description":"Count documents from the vector store using regular filters","operationId":"count_documents_index_count_get","parameters":[{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The criteria to filter the search results","title":"Filter"},"description":"The criteria to filter the search results","examples":{"year equal to":{"summary":"year equal to a specific value","description":"The `year` field equal to a specific value here `2023`","value":"year = 2023"},"year greater than":{"summary":"year greater than a specific value","description":"The `year` field greater than a specific value here `2013`","value":"year > 2013"},"citations in range":{"summary":"citations in a specific range","description":"The `citations` field in a specific range here `10` to `100`","value":"citations > 10, <=100"},"title like":{"summary":"title like a specific value","description":"The `title` field like a specific value here `machine learning`.\n         This will use full text search index to find the documents.","value":"title LIKE \"machine learning\""},"language in list":{"summary":"language in a specific list","description":"The `language` field in a specific list here `en` or `fr`","value":"language IN [\"en\", \"fr\"]"},"full text is null":{"summary":"full text is null","description":"The `full_text` field is null","value":"IS_NULL(full_text)"},"complex filter":{"summary":"complex filter","description":"A complex filter with multiple fields.\n         You can use `AND`, `OR` and `NOT` operators to combine the filters.\n          Here `year` not equal to `2013` and `issbn` not in a specific list and `title` like a specific value","value":"(year != 2013 OR issbn NOT IN [\"1231313\", \"1231355444\"]) AND title LIKE \"machine learning\""}}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantDictResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/index/info":{"get":{"tags":["Semantic Neural Search"],"summary":"Get Indices Info","description":"Get information about the available indices.","operationId":"get_indices_info_index_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QdrantDictResponse"}}}}}}},"/backend/stats":{"get":{"tags":["Common Functionality"],"summary":"Get Data Stats","description":"Get the statistics of the dataset.","operationId":"get_data_stats_backend_stats_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatisticsResponse"}}}}}}},"/backend/questions/recent":{"get":{"tags":["Common Functionality"],"summary":"Get Recently Asked Questions","description":"Get the recent questions.","operationId":"get_recently_asked_questions_backend_questions_recent_get","parameters":[{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"the number of recent questions to return","default":5,"title":"Count"},"description":"the number of recent questions to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuestionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/backend/questions/popular":{"get":{"tags":["Common Functionality"],"summary":"Get Popular Asked Questions","description":"Get the recent questions.","operationId":"get_popular_asked_questions_backend_questions_popular_get","parameters":[{"name":"count","in":"query","required":false,"schema":{"type":"integer","description":"the number of popular questions to return","default":5,"title":"Count"},"description":"the number of popular questions to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuestionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/backend/health":{"get":{"tags":["Common Functionality"],"summary":"Get Backend Health","description":"Get the health of the backend.","operationId":"get_backend_health_backend_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendHealthResponse"}}}}}}},"/backend/version":{"get":{"tags":["Common Functionality"],"summary":"Get Backend Version","description":"Get the backend version","operationId":"get_backend_version_backend_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendVersionResponse"}}}}}}}},"components":{"schemas":{"BackendHealthResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/app__models__backend__BackendHealthResponse__Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"BackendHealthResponse"},"BackendVersionResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/app__models__backend__BackendVersionResponse__Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"BackendVersionResponse"},"BulkIndexRequest":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/IndexRequest"},"type":"array","title":"Documents","description":"The documents to be indexed"}},"type":"object","required":["documents"],"title":"BulkIndexRequest"},"DBpediaEntity":{"properties":{"uri":{"type":"string","title":"Uri","description":"The URI of the DBpedia entity"},"surface_form":{"type":"string","title":"Surface Form","description":"The surface form of the DBpedia entity"}},"type":"object","required":["uri","surface_form"],"title":"DBpediaEntity"},"DatasetStats":{"properties":{"num_items_with_authors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Authors","description":"The number of items with authors"},"num_items_with_abstracts":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Abstracts","description":"The number of items with abstracts"},"num_items_with_languages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Languages","description":"The number of items with language tags"},"num_items_with_topics":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Topics","description":"The number of items with topics"},"num_items_with_subjects":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Subjects","description":"The number of items with subjects"},"num_items_with_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Year","description":"The number of items with year values"},"num_items_with_identifiers":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Identifiers","description":"The number of items with identifiers"},"num_items_with_type":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Type","description":"The number of items with a specific document type"},"num_items_with_issn":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Issn","description":"The number of items with an ISSN"},"num_items_with_doi":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Doi","description":"The number of items with a DOI"},"num_items_with_citations":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Citations","description":"The number of items with citation counts"},"num_items_with_publication_date":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Publication Date","description":"The number of items with publication dates"},"num_items_with_publisher":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Publisher","description":"The number of items with publishers"},"num_items_with_journal":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Journal","description":"The number of items with journal names"},"num_items_with_dbpedia_entities":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items With Dbpedia Entities","description":"The number of items with DBpedia entities"}},"type":"object","title":"DatasetStats","description":"The dataset statistics of the system."},"EntityExtractions":{"properties":{"dbpedia":{"anyOf":[{"items":{"$ref":"#/components/schemas/DBpediaEntity"},"type":"array"},{"type":"null"}],"title":"Dbpedia","description":"The DBpedia entities extracted from the item"}},"type":"object","title":"EntityExtractions"},"ExtractItemValuesFromPropertiesResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/app__models__llm__ExtractItemValuesFromPropertiesResponse__Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"ExtractItemValuesFromPropertiesResponse"},"Extractions-Input":{"properties":{"entities":{"$ref":"#/components/schemas/EntityExtractions","description":"The list of entities"}},"type":"object","required":["entities"],"title":"Extractions"},"Extractions-Output":{"properties":{"entities":{"$ref":"#/components/schemas/EntityExtractions","description":"The list of entities"}},"type":"object","required":["entities"],"title":"Extractions"},"GenerationParameters":{"properties":{"indexes":{"additionalProperties":{"type":"integer"},"type":"object","title":"Indexes"},"collection":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Collection"}},"type":"object","required":["indexes","collection"],"title":"GenerationParameters"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IndexRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Id","description":"The document ID, here is the coreID"},"doi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doi","description":"The DOI of the document"},"oai":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Oai","description":"The OAI of the document"},"title":{"type":"string","title":"Title","description":"The title of the document"},"date_published":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Published","description":"The date published of the document"},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Abstract","description":"The abstract of the document"},"year":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Year","description":"The year of the document"},"issn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issn","description":"The ISSN of the document"},"full_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Text","description":"The full text of the document"},"subjects":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Subjects","description":"A list of subjects of the document"},"urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Urls","description":"A list of URLs of the document"},"identifiers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Identifiers","description":"A list of identifiers of the document"},"topics":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Topics","description":"A list of topics of the document"},"download_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Download Url","description":"The download URL of the document"},"full_text_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Text Identifier","description":"The full text identifier of the document"},"pdf_hash_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Hash Value","description":"The PDF hash value of the document"},"raw_record_xml":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Record Xml","description":"The raw record XML of the document"},"journals":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Journals","description":"A list of journals of the document"},"authors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Authors","description":"A list of authors of the document"},"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher","description":"The publisher of the document"},"relations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Relations","description":"A list of relations of the document"},"contributors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contributors","description":"A list of contributors of the document"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"The language of the document"},"citation_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Citation Count","description":"The citation count of the document"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type","description":"The inferred document type"},"extractions":{"anyOf":[{"$ref":"#/components/schemas/Extractions-Input"},{"type":"null"}],"description":"The automatic extractions from the item"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"The source of the document"}},"type":"object","required":["id","title"],"title":"IndexRequest"},"IndexingStats":{"properties":{"num_indexed_vectors":{"type":"integer","title":"Num Indexed Vectors","description":"The number of indexed vectors in the vector store"},"vector_config":{"$ref":"#/components/schemas/VectorConfig","description":"The configuration of the vectors in the vector store"}},"type":"object","required":["num_indexed_vectors","vector_config"],"title":"IndexingStats","description":"The indexing statistics of the system."},"LLMChatMessage":{"properties":{"role":{"type":"string","enum":["user","assistant","system"],"title":"Role","description":"The role of the message"},"content":{"type":"string","title":"Content","description":"The content of the message"}},"type":"object","required":["role","content"],"title":"LLMChatMessage"},"LLMChatRequest":{"properties":{"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The model to use for generation. If not provided, the default model will be used"},"stream":{"type":"boolean","title":"Stream","description":"Whether to stream the output or not (default: True)","default":true},"messages":{"items":{"$ref":"#/components/schemas/LLMChatMessage"},"type":"array","title":"Messages","description":"The messages to generate the response for"},"temperature":{"type":"number","title":"Temperature","description":"The temperature to use for generation. Default is 0.5.","default":0.5},"top_p":{"type":"number","title":"Top P","description":"The nucleus sampling","default":0.95},"truncate":{"type":"integer","title":"Truncate","description":"The maximum number of tokens to truncate","default":150},"stop":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stop","description":"The stop token to use for generation"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"The seed to use for generation"},"frequency_penalty":{"type":"number","title":"Frequency Penalty","description":"The frequency penalty","default":1},"presence_penalty":{"type":"number","title":"Presence Penalty","description":"The presence penalty","default":0.1}},"type":"object","required":["messages"],"title":"LLMChatRequest"},"LLMGenerateRequest":{"properties":{"prompt":{"type":"string","title":"Prompt","description":"The prompt to generate the response for"},"system":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"System","description":"The system to use for generation. None by default."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The model to use for generation. If not provided, the default model will be used"},"stream":{"type":"boolean","title":"Stream","description":"Whether to stream the output or not (default: True)","default":true},"temperature":{"type":"number","title":"Temperature","description":"The temperature to use for generation. Default is 0.5.","default":0.5},"top_k":{"type":"integer","title":"Top K","description":"The number of tokens to consider for the top-k sampling","default":10},"top_n":{"type":"integer","title":"Top N","description":"The number of tokens to consider for the top-n sampling","default":5},"top_p":{"type":"number","title":"Top P","description":"The nucleus sampling","default":0.95},"truncate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Truncate","description":"The maximum number of tokens to truncate. Default is 150.","default":150},"context_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Context Size","description":"The context size to use for generation"},"context":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Context","description":"The context for the short-term memory"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"The seed to use for generation"}},"type":"object","required":["prompt"],"title":"LLMGenerateRequest"},"LLMRawResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"additionalProperties":true,"type":"object","title":"Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"LLMRawResponse"},"PromptsUsed":{"properties":{"indexes":{"additionalProperties":{"type":"integer"},"type":"object","title":"Indexes"},"collection":{"items":{"$ref":"#/components/schemas/ReproducibilityPrompt"},"type":"array","title":"Collection"}},"type":"object","required":["indexes","collection"],"title":"PromptsUsed"},"QdrantDictResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"additionalProperties":true,"type":"object","title":"Payload","description":"The payload of the response"}},"type":"object","required":["uuid","timestamp","payload"],"title":"QdrantDictResponse"},"QdrantDocument":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"integer"}],"title":"Id","description":"The document ID, here is the coreID"},"doi":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doi","description":"The DOI of the document"},"oai":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Oai","description":"The OAI of the document"},"title":{"type":"string","title":"Title","description":"The title of the document"},"date_published":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date Published","description":"The date published of the document"},"abstract":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Abstract","description":"The abstract of the document"},"year":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Year","description":"The year of the document"},"issn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issn","description":"The ISSN of the document"},"full_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Text","description":"The full text of the document"},"subjects":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Subjects","description":"A list of subjects of the document"},"urls":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Urls","description":"A list of URLs of the document"},"identifiers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Identifiers","description":"A list of identifiers of the document"},"topics":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Topics","description":"A list of topics of the document"},"download_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Download Url","description":"The download URL of the document"},"full_text_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Full Text Identifier","description":"The full text identifier of the document"},"pdf_hash_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pdf Hash Value","description":"The PDF hash value of the document"},"raw_record_xml":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Raw Record Xml","description":"The raw record XML of the document"},"journals":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Journals","description":"A list of journals of the document"},"authors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Authors","description":"A list of authors of the document"},"publisher":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publisher","description":"The publisher of the document"},"relations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Relations","description":"A list of relations of the document"},"contributors":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Contributors","description":"A list of contributors of the document"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"The language of the document"},"citation_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Citation Count","description":"The citation count of the document"},"document_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Type","description":"The inferred document type"},"extractions":{"anyOf":[{"$ref":"#/components/schemas/Extractions-Output"},{"type":"null"}],"description":"The automatic extractions from the item"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","description":"The source of the document"}},"type":"object","required":["id","title"],"title":"QdrantDocument"},"QdrantListDocumentsResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"items":{"$ref":"#/components/schemas/QdrantDocument"},"type":"array","title":"Payload","description":"The list of documents that match the search"}},"type":"object","required":["uuid","timestamp","payload"],"title":"QdrantListDocumentsResponse"},"QdrantPageResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/QdrantDocument"},"type":"array","title":"Items","description":"The list of items retrieved from Qdrant"},"total_hits":{"type":"integer","title":"Total Hits","description":"The total number of documents that can be retrieved from Qdrant"},"has_more":{"type":"boolean","title":"Has More","description":"Whether there are more documents to be retrieved from Qdrant"},"offset":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"Offset","description":"The offset to start fetching documents from, could be int, str, or UUID"}},"type":"object","required":["items","total_hits","has_more"],"title":"QdrantPageResponse"},"QdrantPagedDocumentsResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/QdrantPageResponse","description":"The page of documents that match the search"}},"type":"object","required":["uuid","timestamp","payload"],"title":"QdrantPagedDocumentsResponse"},"QdrantSingleDocumentResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/QdrantDocument","description":"The item that matches the selection criteria"}},"type":"object","required":["uuid","timestamp","payload"],"title":"QdrantSingleDocumentResponse"},"QuestionRecord":{"properties":{"question":{"type":"string","title":"Question","description":"The question"},"frequency":{"type":"integer","title":"Frequency","description":"The frequency of the question","default":1},"nsfw":{"type":"boolean","title":"Nsfw","description":"Whether the question is NSFW","default":false}},"type":"object","required":["question"],"title":"QuestionRecord"},"QuestionsResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/app__models__backend__QuestionsResponse__Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"QuestionsResponse"},"ReproducibilityPrompt":{"properties":{"system":{"type":"string","title":"System","description":"The system that used the prompt"},"user":{"type":"string","title":"User","description":"The user that used the prompt"},"variables":{"additionalProperties":true,"type":"object","title":"Variables","description":"The variables used with the prompt"}},"type":"object","required":["system","user","variables"],"title":"ReproducibilityPrompt"},"StatisticsResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/app__models__backend__StatisticsResponse__Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"StatisticsResponse"},"SynthesisAnswerOfQuestionFromAbstractsResponse":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"payload":{"$ref":"#/components/schemas/app__models__llm__SynthesisAnswerOfQuestionFromAbstractsResponse__Payload"}},"type":"object","required":["uuid","timestamp","payload"],"title":"SynthesisAnswerOfQuestionFromAbstractsResponse"},"UsageStats":{"properties":{"num_registered_users":{"type":"integer","title":"Num Registered Users","description":"The number of registered users in the system"},"num_cache_hits":{"type":"integer","title":"Num Cache Hits","description":"The number of cache hits in the system"},"num_collections":{"type":"integer","title":"Num Collections","description":"The number of user-created collections in the system"},"num_collection_items":{"type":"integer","title":"Num Collection Items","description":"The number of items in bibtex imported items to the system"},"num_saved_searches":{"type":"integer","title":"Num Saved Searches","description":"The number of saved searches in the system"},"num_shared_links":{"type":"integer","title":"Num Shared Links","description":"The number of shared links in the system"},"num_questions_asked":{"type":"integer","title":"Num Questions Asked","description":"Approximate number of non-unique questions asked to the system"}},"type":"object","required":["num_registered_users","num_cache_hits","num_collections","num_collection_items","num_saved_searches","num_shared_links","num_questions_asked"],"title":"UsageStats","description":"The usage statistics of the system."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VectorConfig":{"properties":{"vector_size":{"type":"integer","title":"Vector Size","description":"The size of the vectors in the vector store"},"distance_method":{"type":"string","title":"Distance Method","description":"The method used to calculate the distance between vectors"}},"type":"object","required":["vector_size","distance_method"],"title":"VectorConfig","description":"The configuration of the vectors in the vector store."},"app__models__backend__BackendHealthResponse__Payload":{"properties":{"message":{"type":"string","title":"Message","description":"The health status of the backend service"},"code":{"type":"integer","title":"Code","description":"The status code of the health check"}},"type":"object","required":["message","code"],"title":"Payload"},"app__models__backend__BackendVersionResponse__Payload":{"properties":{"version":{"type":"string","title":"Version","description":"The version of the backend service"}},"type":"object","required":["version"],"title":"Payload"},"app__models__backend__QuestionsResponse__Payload":{"properties":{"questions":{"items":{"$ref":"#/components/schemas/QuestionRecord"},"type":"array","title":"Questions"}},"type":"object","required":["questions"],"title":"Payload"},"app__models__backend__StatisticsResponse__Payload":{"properties":{"indexing":{"$ref":"#/components/schemas/IndexingStats"},"dataset":{"$ref":"#/components/schemas/DatasetStats"},"usage":{"$ref":"#/components/schemas/UsageStats"}},"type":"object","required":["indexing","dataset","usage"],"title":"Payload"},"app__models__llm__ExtractItemValuesFromPropertiesResponse__Payload":{"properties":{"item_id":{"anyOf":[{"type":"integer"},{"type":"string"}],"title":"Item Id","description":"The ID of the item to extract properties from"},"properties":{"items":{"type":"string"},"type":"array","title":"Properties","description":"The properties to extract from the item"},"values":{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]},"type":"array"},{"type":"integer"},{"type":"number"}]},"type":"object","title":"Values","description":"The extracted values for the properties"},"extra":{"additionalProperties":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}]},"type":"array"},{"type":"integer"},{"type":"number"}]},"type":"object","title":"Extra","description":"Extra values detected by the LLM"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"The seed used during extraction (if any)"},"reproducibility":{"anyOf":[{"$ref":"#/components/schemas/app__models__llm__ExtractItemValuesFromPropertiesResponse__Reproducibility"},{"type":"null"}],"description":"The reproducibility parameters for the extraction"}},"type":"object","required":["item_id","properties","values","extra"],"title":"Payload"},"app__models__llm__ExtractItemValuesFromPropertiesResponse__Reproducibility":{"properties":{"parameters":{"$ref":"#/components/schemas/GenerationParameters","description":"The llm generation parameters"},"prompts":{"$ref":"#/components/schemas/PromptsUsed","description":"The prompt used for generation"}},"type":"object","required":["parameters","prompts"],"title":"Reproducibility"},"app__models__llm__SynthesisAnswerOfQuestionFromAbstractsResponse__Payload":{"properties":{"items_mapping":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"object","title":"Items Mapping","description":"The item IDs mappings to the citations"},"collection_items_mapping":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"object","title":"Collection Items Mapping","description":"The collection item IDs mappings to the citations"},"question":{"type":"string","title":"Question","description":"The question to synthesize the answer for"},"synthesis":{"type":"string","title":"Synthesis","description":"The synthesized answer for the question"},"seed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Seed","description":"The seed used during synthesis (if any)"},"reproducibility":{"anyOf":[{"$ref":"#/components/schemas/app__models__llm__SynthesisAnswerOfQuestionFromAbstractsResponse__Reproducibility"},{"type":"null"}],"description":"The reproducibility parameters for the synthesis"}},"type":"object","required":["items_mapping","collection_items_mapping","question","synthesis"],"title":"Payload"},"app__models__llm__SynthesisAnswerOfQuestionFromAbstractsResponse__Reproducibility":{"properties":{"parameters":{"additionalProperties":true,"type":"object","title":"Parameters","description":"The llm generation parameters"},"prompt":{"$ref":"#/components/schemas/ReproducibilityPrompt","description":"The prompt used for generation"}},"type":"object","required":["parameters","prompt"],"title":"Reproducibility"}}},"servers":[{"url":"https://api.ask.orkg.org","description":"Production server"}]}