HIX Scholar · Actions GPT

{
  "info": {
    "title": "HIX Scholar",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://scholar.hix.ai/"
    }
  ],
  "openapi": "3.1.0",
  "paths": {
    "/api/gpts": {
      "get": {
        "description": "An endpoint that can be called to ask a question of research papers",
        "operationId": "search_papers",
        "parameters": [
          {
            "description": "A query to find relevant research papers. To search effectively, ask research questions related to scientific topics, such as 'the future of manipulation of genes and DNA' or 'the benefits of the study of genes and heredity'. Ask broad yes/no questions, inquire about the relationship between concepts, or ask about the effects or impact of a concept. Use technical language where possible to maximize the relevance to academic text. For example, if the user asks 'Why do some foods taste sweet?', search 'What causes different taste sensations in foods?'. Remove unnecessary commands like 'latest research' and 'find papers' and focus only on words likely to match with the text of research papers.",
            "in": "query",
            "name": "query",
            "required": true,
            "schema": {
              "description": "A query to find relevant research papers. To search effectively, ask research questions related to scientific topics, such as 'the future of manipulation of genes and DNA' or 'the benefits of the study of genes and heredity'. Ask broad yes/no questions, inquire about the relationship between concepts, or ask about the effects or impact of a concept. Use technical language where possible to maximize the relevance to academic text. For example, if the user asks 'Why do some foods taste sweet and others taste sour?', search 'What causes different taste sensations in foods?'. Remove unnecessary commands like 'latest research' and 'find papers' and focus only on words likely to match with the text of research papers.",
              "title": "keyword",
              "type": "string"
            }
          },
          {
            "description": "The earliest publication year to consider in the search, filtering out papers published before this year. You must only use this filter when the user asks for information after a certain date. An example of when to use this filter would be if a user asks 'Show me articles about renewable energy published after 2018.' or 'Find research papers about artificial intelligence published between 2015 and 2020.'. If you use this filter without the user specifically including a date or 'recent research', you will be penalized.",
            "in": "query",
            "name": "yearMin",
            "required": false,
            "schema": {
              "description": "The earliest publication year to consider in the search, filtering out papers published before this year. You must only use this filter when the user asks for information after a certain date. An example of when to use this filter would be if a user asks 'Show me articles about renewable energy published after 2020.' or 'Find research papers about artificial intelligence published between 2015 and 2020.'. If you use this filter without the user specifically including a date or 'recent research', you will be penalized.",
              "title": "Year Min",
              "type": "integer"
            }
          },
          {
            "description": "The latest publication year to consider in the search, filtering out papers published after this year. You must only use this filter when the user asks for information before a certain date. An example of when to use this filter would be if a user asks 'Show me scientific studies on climate change published before 2023' or 'Find research papers about artificial intelligence published between 2015 and 2020.'. Only use this filter when a specific year restriction is requested by the user",
            "in": "query",
            "name": "yearMax",
            "required": false,
            "schema": {
              "description": "The latest publication year to consider in the search, filtering out papers published after this year. You must only use this filter when the user asks for information before a certain date. An example of when to use this filter would be if a user asks 'Show me scientific studies on climate change published before 2023' or 'Find research papers about artificial intelligence published between 2015 and 2020.'. Only use this filter when a specific year restriction is requested by the user",
              "title": "Year Max",
              "type": "integer"
            }
          },
          {
            "description": "List of study types to include in the search, such as RCT, Meta-Analysis, Systematic Review, Observational Study, Case Report etc. You must only use this filter when the user asks for information from papers with certain study designs. Examples of when to use this filter would be if a user asks 'Show me the effects of exercise on sleep quality in randomized controlled trials from RCT' or 'Find me a meta-analysis on the effectiveness of cognitive-behavioral therapy (CBT) for anxiety disorders.'. Only use this filter when a specific study type is asked about",
            "in": "query",
            "name": "studyType",
            "required": false,
            "schema": {
              "description": "List of study types to include in the search, such as RCT, Meta-Analysis, Systematic Review, Observational Study, Case Report etc. You must only use this filter when the user asks for information from papers with certain study designs. Examples of when to use this filter would be if a user asks 'Show me the effects of exercise on sleep quality in randomized controlled trials from RCT' or 'Find me a meta-analysis on the effectiveness of cognitive-behavioral therapy (CBT) for anxiety disorders.'. Only use this filter when a specific study type is asked about",
              "title": "Study Type",
              "type": "string"
            }
          },
          {
            "description": "List of study types to include in the search, such as RCT, Meta-Analysis, Systematic Review, Observational Study, Case Report etc. You must only use this filter when the user asks for information from papers with certain study designs. Examples of when to use this filter would be if a user asks 'Show me the effects of exercise on sleep quality in randomized controlled trials from RCT' or 'Find me a meta-analysis on the effectiveness of cognitive-behavioral therapy (CBT) for anxiety disorders.'. Only use this filter when a specific study type is asked about",
            "in": "query",
            "name": "publishType",
            "required": false,
            "schema": {
              "description": "List of study types to include in the search, such as RCT, Meta-Analysis, Systematic Review, Observational Study, Case Report etc. You must only use this filter when the user asks for information from papers with certain study designs. Examples of when to use this filter would be if a user asks 'Show me the effects of exercise on sleep quality in randomized controlled trials from RCT' or 'Find me a meta-analysis on the effectiveness of cognitive-behavioral therapy (CBT) for anxiety disorders.'. Only use this filter when a specific study type is asked about",
              "title": "Publication Type",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QuickSearchResponse"
                }
              }
            },
            "description": "Successful Response"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            },
            "description": "Validation Error"
          }
        },
        "security": [
          {
            "HTTPBearer": []
          }
        ],
        "summary": "Returns research papers related to a question or query. Each result contains, title, abstract, authors, year, and journal.",
        "tags": [
          "search"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "properties": {
          "message": {
            "title": "Message",
            "type": "string",
            "$ref": "#/components/schemas/ValidationError"
          }
        },
        "title": "HTTPValidationError",
        "type": "object"
      },
      "QuickSearchResponse": {
        "properties": {
          "items": {
            "description": "All answers to the question.",
            "items": {
              "$ref": "#/components/schemas/QuickSearchResponseItem"
            },
            "title": "Items",
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "title": "QuickSearchResponse",
        "type": "object"
      },
      "QuickSearchResponseItem": {
        "properties": {
          "abstract": {
            "description": "The abstract of the paper.",
            "title": "Abstract",
            "type": "string"
          },
          "detailURL": {
            "description": "A URL with more details on the paper.",
            "title": "HIX Scholar Paper Details Url",
            "type": "string"
          },
          "doi": {
            "description": "Digital Object Identifier, a unique alphanumeric string assigned to a document for permanent access.",
            "title": "Doi",
            "type": "string"
          },
          "pages": {
            "description": "The page range of the paper within the journal volume.",
            "title": "Pages",
            "type": "string"
          },
          "authors": {
            "description": "A list of authors of the paper.",
            "items": {
              "type": "string"
            },
            "title": "Paper Authors",
            "type": "array"
          },
          "year": {
            "description": "The year the paper was published.",
            "title": "Paper Publish Year",
            "type": "integer"
          },
          "title": {
            "description": "Title of the paper where the answer was found",
            "title": "Paper Title",
            "type": "string"
          },
          "journalName": {
            "description": "The journal the paper was published in.",
            "title": "Publication Journal Name",
            "type": "string"
          },
          "referenceCount": {
            "description": "Total number of papers referenced by this paper.",
            "title": "Search Result Number",
            "type": "integer"
          },
          "citationCount": {
            "description": "Total number of citations S2 has found for this paper.",
            "title": "Search Result Number",
            "type": "integer"
          },
          "journalVolume": {
            "description": "The volume of the journal in which the paper appears.",
            "title": "Volume",
            "type": "string"
          }
        },
        "required": [
          "title",
          "abstract",
          "authors",
          "year",
          "journalName",
          "detialURL",
          "doi",
          "journalVolume",
          "pages",
          "referenceCount",
          "citationCount"
        ],
        "title": "QuickSearchResponseData",
        "type": "object"
      },
      "StudyTypeKeywordEnum": {
        "description": "All possible study types strings saved to search index documents.",
        "type": "string",
        "enum": [
          "Computer Science",
          "Medicine",
          "Chemistry",
          "Biology",
          "Materials Science",
          "Physics",
          "Geology",
          "Psychology",
          "Art",
          "History",
          "Geography",
          "Sociology",
          "Business",
          "Political Science",
          "Economics",
          "Philosophy",
          "Mathematics",
          "Engineering",
          "Environmental Science",
          "Agricultural and Food Sciences",
          "Education",
          "Law",
          "Linguistics"
        ],
        "title": "StudyTypeKeywordEnum"
      },
      "ValidationError": {
        "properties": {
          "message": {
            "title": "Message",
            "type": "string"
          }
        },
        "required": [
          "message"
        ],
        "title": "ValidationError",
        "type": "object"
      }
    },
    "securitySchemes": {
      "HTTPBearer": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}