<commit_before><!DOCTYPE HTML>
<html>
  <head>
    <title>BloomAPI - Find and Compare Physicians</title>
    <link rel="stylesheet" href="css/style.css" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  </head>
  <body>
    <nav class="cover">
      <div>
        <h1 class="pull-left"><a href="/">bloom.api</a></h1>
        <ul class="pull-right">
          <li><a href="/">home</a></li>
          <li><a href="/search#">search</a></li>
          <li class="active"><a href="/documentation">documentation</a></li>
          <li><a href="/contribute">contribute</a></li>
        </ul>
      </div>
    </nav>
    <div class="row-skipnav">
      <h1>Documentation</h1>
      <h2>Querying</h2>
      <p>
        BloomAPI can be queried at http://www.bloomapi.com/api/ or at your own deployment.
        Here is a summary of the available APIs.
      </p>
      <h3>GET /search</h3>
      <ul class="params">
        <li>
          <strong>key*</strong> name of field to filter by. Replace * with any number to set the 'index number'. The index number is used to associate keys with an 'op' and 'value'
        </li>
        <li>
          <strong>op*</strong> search operation to apply for a given index number. Currenlty 'eq' is the only possible value
        </li>
        <li>
          <strong>value*</strong> value to search for given an index number
        </li>
        <li>
          <strong>limit</strong> optional, sets the maximum number of records to return. Default is 20 and maximum is 100
        </li>
        <li>
          <strong>offset</strong> optional, sets a number of records to skip before returning. Default is 0
        </li>
    </ul>
    <h2>Responses</h2>
      <p>Responses are JSON formated objects that have the result set as well as additional metadata</p>
      <p>Return codes</p>
      <ul>
        <li><strong>200</strong>: Successly queried</li>
        <li><strong>400</strong>: User error such as invalid parameters</li>
        <li><strong>500</strong>: Server error. Likely caused by a bug in BloomAPI</li>
      </ul>
      <p>200 Structure</p>
      <code>{
  meta: {
    count: <i>Total count without limit</i>
  },
  result: [
    {
      npi: 1111111111,
      type: "individual",
      ...
    },
    ...
  ]
}
      </code>
      <p>400/500 Structure</p>
      <code>{
  error: "Error message",
  type: "parameter|fatal",
  details: {
    <i>An object that represents this error type</i>
  }
}
      </code>
    <h2>Fields</h2>
      <p>Coming Soon (July 2013)</p>
    <h2>Deploy</h2>
      <p>Deploy your own copy of BloomAPI to gain higher performance or high availability to meet your own SLAs. Alternatively deploy it to gain an on-site database containing the lastest version of the NPI data dissemination.</p>
      <p>BloomAPI provides a set of <a href="http://www.ansible.cc/" target="_blank">Ansible</a> playbooks that can be used to automatically deploy BloomAPI and all of its dependencies on top of a clean installation of Ubuntu 13.04.</p>
      <p>To install Ansible on mac OSX:</p>
      <code>brew install python --framework
sudo pip install ansible
      </code>
      <p>To install Ansible on Ubuntu</p>
      <code>sudo apt-get install python
sudo easy_install pip
sudo pip install ansible
      </code>
      <p>To see more details on installing Ansible, see the <a href="http://www.ansibleworks.com/docs/gettingstarted.html" target="_blank">Ansible Getting Started</a> page.</p>
      <p>Once ansible is installed:</p>
      <ol>
        <li>Create a clean installation of Ubuntu 13.04. The machine should have at least 12GB of free disk space for the dissemination file downloads/ extraction</li><commit_msg>Update documentation.html<commit_after><!DOCTYPE HTML>
<html>
  <head>
    <title>BloomAPI - Find and Compare Physicians</title>
    <link rel="stylesheet" href="css/style.css" />
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  </head>
  <body>
    <nav class="cover">
      <div>
        <h1 class="pull-left"><a href="/">bloom.api</a></h1>
        <ul class="pull-right">
          <li><a href="/">home</a></li>
          <li><a href="/search#">search</a></li>
          <li class="active"><a href="/documentation">documentation</a></li>
          <li><a href="/contribute">contribute</a></li>
        </ul>
      </div>
    </nav>
    <div class="row-skipnav">
      <h1>Documentation</h1>
      <h2>Querying</h2>
      <p>
        BloomAPI can be queried at http://www.bloomapi.com/api/ or at your own deployment.
        Here is a summary of the available APIs.
      </p>
      <h3>GET /search</h3>
      <ul class="params">
        <li>
          <strong>key*</strong> name of field to filter by. Replace * with any number to set the 'index number'. The index number is used to associate keys with an 'op' and 'value'
        </li>
        <li>
          <strong>op*</strong> search operation to apply for a given index number. Currenlty 'eq' is the only possible value
        </li>
        <li>
          <strong>value*</strong> value to search for given an index number
        </li>
        <li>
          <strong>limit</strong> optional, sets the maximum number of records to return. Default is 20 and maximum is 100
        </li>
        <li>
          <strong>offset</strong> optional, sets a number of records to skip before returning. Default is 0
        </li>
    </ul>
    <h2>Responses</h2>
      <p>Responses are JSON formated objects that have the result set as well as additional metadata</p>
      <p>Return codes</p>
      <ul>
        <li><strong>200</strong>: Successly queried</li>
        <li><strong>400</strong>: User error such as invalid parameters</li>
        <li><strong>500</strong>: Server error. Likely caused by a bug in BloomAPI</li>
      </ul>
      <p>200 Structure</p>
      <code>{
  meta: {
    count: <i>Total count without limit</i>
  },
  result: [
    {
      npi: 1111111111,
      type: "individual",
      ...
    },
    ...
  ]
}
      </code>
      <p>400/500 Structure</p>
      <code>{
  error: "Error message",
  type: "parameter|fatal",
  details: {
    <i>An object that represents this error type</i>
  }
}
      </code>
    <h2>Fields</h2>
      <p>Coming Soon (August 2013)</p>
    <h2>Deploy</h2>
      <p>Deploy your own copy of BloomAPI to gain higher performance or high availability to meet your own SLAs. Alternatively deploy it to gain an on-site database containing the lastest version of the NPI data dissemination.</p>
      <p>BloomAPI provides a set of <a href="http://www.ansible.cc/" target="_blank">Ansible</a> playbooks that can be used to automatically deploy BloomAPI and all of its dependencies on top of a clean installation of Ubuntu 13.04.</p>
      <p>To install Ansible on mac OSX:</p>
      <code>brew install python --framework
sudo pip install ansible
      </code>
      <p>To install Ansible on Ubuntu</p>
      <code>sudo apt-get install python
sudo easy_install pip
sudo pip install ansible
      </code>
      <p>To see more details on installing Ansible, see the <a href="http://www.ansibleworks.com/docs/gettingstarted.html" target="_blank">Ansible Getting Started</a> page.</p>
      <p>Once ansible is installed:</p>
      <ol>
        <li>Create a clean installation of Ubuntu 13.04. The machine should have at least 12GB of free disk space for the dissemination file downloads/ extraction</li>
{'fraction_non_alphanumeric': 0.13468783638320775, 'fraction_numerical': 0.016953713670613563, 'mean_word_length': 2.5513616817964646, 'pattern_counts': {'":': 0, '<': 257, '<?xml version=': 0, '>': 257, 'https://': 0, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 2, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1644242', 'n_tokens_mistral': 2433, 'n_tokens_neox': 2270, 'n_words': 768}