RadiologyGPT

RadiologyGPT · GPT アクション

NCBI Entrez Programming Utilities API

Interface for querying and retrieving data from NCBI's Entrez system.

  • GET /einfo.fcgiDatabase statistics
  • GET /esearch.fcgiText searches
  • GET /epost.fcgiUID uploads
  • GET /esummary.fcgiDocument summary downloads
  • GET /efetch.fcgiData record downloads
  • GET /elink.fcgiEntrez links
元の API スキーマ
{
  "openapi": "3.1.0",
  "info": {
    "title": "NCBI Entrez Programming Utilities API",
    "version": "1.0.0",
    "description": "Interface for querying and retrieving data from NCBI's Entrez system."
  },
  "servers": [
    {
      "url": "https://eutils.ncbi.nlm.nih.gov/entrez/eutils/"
    }
  ],
  "paths": {
    "/einfo.fcgi": {
      "get": {
        "summary": "Database statistics",
        "operationId": "getDatabaseStatistics",
        "responses": {
          "200": {
            "description": "Successful operation"
          }
        }
      }
    },
    "/esearch.fcgi": {
      "get": {
        "summary": "Text searches",
        "operationId": "performTextSearch",
        "parameters": [
          {
            "name": "term",
            "in": "query",
            "required": true,
            "description": "Search terms for querying the database.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "db",
            "in": "query",
            "required": true,
            "description": "Database to search. Example values include 'pubmed', 'pmc', 'nlmcatalog'.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "datetype",
            "in": "query",
            "description": "Date type to limit the search. Valid values include 'crdt', 'edat', 'pdat', 'mhda'.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "reldate",
            "in": "query",
            "description": "Limits search to last n days.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "mindate",
            "in": "query",
            "description": "Start of date range in YYYY/MM/DD format.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "maxdate",
            "in": "query",
            "description": "End of date range in YYYY/MM/DD format.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "retmode",
            "in": "query",
            "required": true,
            "description": "Format of the returned output. Default is 'xml', 'json' also supported.",
            "schema": {
              "type": "string"
            },
            "example": "json"
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sort order of the results. Valid values include 'journal', 'pub+date', 'most+recent', 'relevance', 'title', 'author'.",
            "schema": {
              "type": "string"
            },
            "example": "most+recent"
          }
        ],
        "responses": {
          "200": {
            "description": "Search results",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ESearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    },
    "/epost.fcgi": {
      "get": {
        "summary": "UID uploads",
        "operationId": "uploadUIDs",
        "parameters": [
          {
            "name": "db",
            "in": "query",
            "required": true,
            "description": "Database containing the UIDs you wish to upload.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "required": true,
            "description": "Single UID or comma-delimited list of UIDs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "WebEnv",
            "in": "query",
            "description": "Specifies the Web Environment for uploaded UIDs.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation"
          }
        }
      }
    },
    "/esummary.fcgi": {
      "get": {
        "summary": "Document summary downloads",
        "operationId": "downloadDocumentSummary",
        "parameters": [
          {
            "name": "db",
            "in": "query",
            "required": true,
            "description": "Database containing the UIDs for document summaries.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "required": true,
            "description": "Single UID or comma-delimited list of UIDs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "retstart",
            "in": "query",
            "description": "Determines the start point of output.",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation"
          }
        }
      }
    },
    "/efetch.fcgi": {
      "get": {
        "summary": "Data record downloads",
        "operationId": "downloadDataRecords",
        "parameters": [
          {
            "name": "db",
            "in": "query",
            "required": true,
            "description": "Database containing the UIDs for which you wish to retrieve records.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "required": true,
            "description": "Single UID or comma-delimited list of UIDs.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "retstart",
            "in": "query",
            "description": "Start point of records in output.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "retmax",
            "in": "query",
            "description": "Total number of records to be shown in the output, up to 10,000.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "retmode",
            "in": "query",
            "description": "Data format of the results (e.g. XML, plain text).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "rettype",
            "in": "query",
            "description": "Specific view of the records (e.g. MEDLINE, Abstract).",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation"
          }
        }
      }
    },
    "/elink.fcgi": {
      "get": {
        "summary": "Entrez links",
        "operationId": "getEntrezLinks",
        "parameters": [
          {
            "name": "dbfrom",
            "in": "query",
            "required": true,
            "description": "Origin database of the link.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "db",
            "in": "query",
            "required": true,
            "description": "Destination database of the link.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "required": true,
            "description": "Single UID or comma-delimited list of UIDs from the dbfrom database.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "cmd",
            "in": "query",
            "required": true,
            "description": "Command mode for ELink, determining the type of links or information output.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ESearchResponse": {
        "type": "object",
        "properties": {
          "response_data": {
            "type": "object",
            "properties": {
              "header": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "example": "esearch"
                  },
                  "version": {
                    "type": "string",
                    "example": "0.3"
                  }
                }
              },
              "esearchresult": {
                "type": "object",
                "properties": {
                  "count": {
                    "type": "string",
                    "example": "4362"
                  },
                  "retmax": {
                    "type": "string",
                    "example": "20"
                  },
                  "retstart": {
                    "type": "string",
                    "example": "0"
                  },
                  "idlist": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "translationset": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "from": {
                          "type": "string"
                        },
                        "to": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "querytranslation": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "required": [
          "response_data"
        ]
      },
      "ErrorResponse": {
        "type": "object",
        "properties": {
          "status_code": {
            "type": "integer",
            "format": "int32"
          },
          "action_id": {
            "type": "string"
          }
        },
        "required": [
          "status_code",
          "action_id"
        ]
      }
    }
  }
}