Skip to content

Commit

Permalink
Update to version 1.0.0rc0 and update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Felix Finkbeiner committed Aug 12, 2020
1 parent 49f6647 commit e36473a
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 200 deletions.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
View file
Binary file not shown.
65 changes: 4 additions & 61 deletions docs/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,34 +35,13 @@
<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#E"><strong>E</strong></a>
<a href="#C"><strong>C</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#W"><strong>W</strong></a>

</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.batch.ActionsBatchRequest">ActionsBatchRequest (class in weaviate.batch)</a>
</li>
<li><a href="index.html#weaviate.batch.ActionsBatchRequest.add_action">add_action() (weaviate.batch.ActionsBatchRequest method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.batch.ReferenceBatchRequest.add_reference">add_reference() (weaviate.batch.ReferenceBatchRequest method)</a>
</li>
<li><a href="index.html#weaviate.batch.ThingsBatchRequest.add_thing">add_thing() (weaviate.batch.ThingsBatchRequest method)</a>
</li>
</ul></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
Expand All @@ -71,29 +50,15 @@ <h2 id="C">C</h2>
</ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.batch.EntityBatchRequest">EntityBatchRequest (class in weaviate.batch)</a>
</li>
</ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.util.generate_local_beacon">generate_local_beacon() (in module weaviate.util)</a>
</li>
<li><a href="index.html#weaviate.util.get_domain_from_weaviate_url">get_domain_from_weaviate_url() (in module weaviate.util)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.batch.ActionsBatchRequest.get_request_body">get_request_body() (weaviate.batch.ActionsBatchRequest method)</a>

<ul>
<li><a href="index.html#weaviate.batch.ThingsBatchRequest.get_request_body">(weaviate.batch.ThingsBatchRequest method)</a>
<li><a href="index.html#weaviate.util.get_domain_from_weaviate_url">get_domain_from_weaviate_url() (in module weaviate.util)</a>
</li>
</ul></li>
<li><a href="index.html#weaviate.util.get_uuid_from_weaviate_url">get_uuid_from_weaviate_url() (in module weaviate.util)</a>
</li>
</ul></td>
Expand All @@ -102,6 +67,8 @@ <h2 id="G">G</h2>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.util.is_object_url">is_object_url() (in module weaviate.util)</a>
</li>
<li><a href="index.html#weaviate.client.Client.is_reachable">is_reachable() (weaviate.client.Client method)</a>
</li>
</ul></td>
Expand Down Expand Up @@ -130,30 +97,6 @@ <h2 id="M">M</h2>
</ul></td>
</tr></table>

<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.client.Client.query">query() (weaviate.client.Client method)</a>
</li>
</ul></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.batch.ReferenceBatchRequest">ReferenceBatchRequest (class in weaviate.batch)</a>
</li>
</ul></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#weaviate.batch.ThingsBatchRequest">ThingsBatchRequest (class in weaviate.batch)</a>
</li>
</ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
Expand Down
155 changes: 18 additions & 137 deletions docs/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,145 +48,9 @@
</dl>
</dd></dl>

<dl class="py method">
<dt id="weaviate.client.Client.query">
<code class="sig-name descname">query</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">gql_query</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.client.Client.query" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>Allows to send simple graph QL string queries.</dt><dd><p>To create more complex GQL queries please use a GQL python client.
Be cautious of injection risks when generating query strings.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>gql_query</strong> (<em>str</em>) – A GQL query in form of a string</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Data response of the query</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>TypeError: If parameter has the wrong type.
ConnectionError: if the network connection to weaviate fails.
UnexpectedStatusCodeException: if weaviate reports a none OK status.</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<span class="target" id="module-weaviate.batch"></span><dl class="py class">
<dt id="weaviate.batch.ActionsBatchRequest">
<em class="property">class </em><code class="sig-prename descclassname">weaviate.batch.</code><code class="sig-name descname">ActionsBatchRequest</code><a class="headerlink" href="#weaviate.batch.ActionsBatchRequest" title="Permalink to this definition"></a></dt>
<dd><p>Collect things for one batch request to weaviate.
Caution this batch will not be validated through weaviate.</p>
<dl class="py method">
<dt id="weaviate.batch.ActionsBatchRequest.add_action">
<code class="sig-name descname">add_action</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">action</span></em>, <em class="sig-param"><span class="n">class_name</span></em>, <em class="sig-param"><span class="n">uuid</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.batch.ActionsBatchRequest.add_action" title="Permalink to this definition"></a></dt>
<dd><p>Add an action to this batch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>action</strong> (<em>dict</em>) – that should be added as part of the batch.</p></li>
<li><p><strong>class_name</strong> (<em>str</em>) – class of the action.</p></li>
<li><p><strong>uuid</strong> (<em>str</em>) – if given the thing will be added under this uuid.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>TypeError, ValueError</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="weaviate.batch.ActionsBatchRequest.get_request_body">
<code class="sig-name descname">get_request_body</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.batch.ActionsBatchRequest.get_request_body" title="Permalink to this definition"></a></dt>
<dd><p>Get the request body as it is needed for weaviate</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the request body as a dict</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="weaviate.batch.EntityBatchRequest">
<em class="property">class </em><code class="sig-prename descclassname">weaviate.batch.</code><code class="sig-name descname">EntityBatchRequest</code><a class="headerlink" href="#weaviate.batch.EntityBatchRequest" title="Permalink to this definition"></a></dt>
<dd><p>Base for storing entities</p>
</dd></dl>

<dl class="py class">
<dt id="weaviate.batch.ReferenceBatchRequest">
<em class="property">class </em><code class="sig-prename descclassname">weaviate.batch.</code><code class="sig-name descname">ReferenceBatchRequest</code><a class="headerlink" href="#weaviate.batch.ReferenceBatchRequest" title="Permalink to this definition"></a></dt>
<dd><p>Collect references to add them in one request to weaviate.
Caution this request will miss some validations to be faster.</p>
<dl class="py method">
<dt id="weaviate.batch.ReferenceBatchRequest.add_reference">
<code class="sig-name descname">add_reference</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">from_entity_uuid</span></em>, <em class="sig-param"><span class="n">from_entity_class_name</span></em>, <em class="sig-param"><span class="n">from_property_name</span></em>, <em class="sig-param"><span class="n">to_entity_uuid</span></em>, <em class="sig-param"><span class="n">from_semantic_type</span><span class="o">=</span><span class="default_value">'things'</span></em>, <em class="sig-param"><span class="n">to_semantic_type</span><span class="o">=</span><span class="default_value">'things'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.batch.ReferenceBatchRequest.add_reference" title="Permalink to this definition"></a></dt>
<dd><p>Add one reference to this batch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>from_entity_uuid</strong> (<em>str in form of UUID</em>) – The UUID or URL of the thing that should reference another entity.</p></li>
<li><p><strong>from_entity_class_name</strong> (<em>str</em>) – The name of the class that should reference another entity.</p></li>
<li><p><strong>from_property_name</strong> (<em>str</em>) – The name of the property that contains the reference.</p></li>
<li><p><strong>to_entity_uuid</strong> (<em>str</em>) – The UUID or URL of the thing that is actually referenced.</p></li>
<li><p><strong>from_semantic_type</strong> (<em>str</em>) – Either things or actions.
Defaults to things.
Settable through the constants SEMANTIC_TYPE_THINGS and SEMANTIC_TYPE_ACTIONS</p></li>
<li><p><strong>to_semantic_type</strong> (<em>str</em>) – Either things or actions.
Defaults to things.
Settable through the constants SEMANTIC_TYPE_THINGS and SEMANTIC_TYPE_ACTIONS</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>None if successful</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>TypeError: If arguments are not string.</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="weaviate.batch.ThingsBatchRequest">
<em class="property">class </em><code class="sig-prename descclassname">weaviate.batch.</code><code class="sig-name descname">ThingsBatchRequest</code><a class="headerlink" href="#weaviate.batch.ThingsBatchRequest" title="Permalink to this definition"></a></dt>
<dd><p>Collect things for one batch request to weaviate.
Caution this batch will not be validated through weaviate.</p>
<dl class="py method">
<dt id="weaviate.batch.ThingsBatchRequest.add_thing">
<code class="sig-name descname">add_thing</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">thing</span></em>, <em class="sig-param"><span class="n">class_name</span></em>, <em class="sig-param"><span class="n">uuid</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.batch.ThingsBatchRequest.add_thing" title="Permalink to this definition"></a></dt>
<dd><p>Add a thing to this batch</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>thing</strong> (<em>dict</em>) – that should be added as part of the batch.</p></li>
<li><p><strong>class_name</strong> (<em>str</em>) – class of the thing.</p></li>
<li><p><strong>uuid</strong> (<em>str</em>) – if given the thing will be added under this uuid.</p></li>
</ul>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p>TypeError, ValueError</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="weaviate.batch.ThingsBatchRequest.get_request_body">
<code class="sig-name descname">get_request_body</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.batch.ThingsBatchRequest.get_request_body" title="Permalink to this definition"></a></dt>
<dd><p>Get the request body as it is needed for weaviate</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the request body as a dict</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<span class="target" id="module-weaviate.util"></span><dl class="py function">
<span class="target" id="module-weaviate.batch"></span><span class="target" id="module-weaviate.util"></span><dl class="py function">
<dt id="weaviate.util.generate_local_beacon">
<code class="sig-prename descclassname">weaviate.util.</code><code class="sig-name descname">generate_local_beacon</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">to_uuid</span></em>, <em class="sig-param"><span class="n">semantic_type</span><span class="o">=</span><span class="default_value">'things'</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.util.generate_local_beacon" title="Permalink to this definition"></a></dt>
<dd><p>Generates a beacon to the given schema class type with the given uuid.</p>
Expand Down Expand Up @@ -231,6 +95,23 @@
</dl>
</dd></dl>

<dl class="py function">
<dt id="weaviate.util.is_object_url">
<code class="sig-prename descclassname">weaviate.util.</code><code class="sig-name descname">is_object_url</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">input</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.util.is_object_url" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>Validates if an url like <a class="reference external" href="http://localhost:8080/v1/things/1c9cd584-88fe-5010-83d0-017cb3fcb446">http://localhost:8080/v1/things/1c9cd584-88fe-5010-83d0-017cb3fcb446</a> references a thing.</dt><dd><p>it only validates the path not the host or the protocol</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>input</strong> (<em>str</em>) – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt id="weaviate.util.is_semantic_type">
<code class="sig-prename descclassname">weaviate.util.</code><code class="sig-name descname">is_semantic_type</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">semantic_type</span></em><span class="sig-paren">)</span><a class="headerlink" href="#weaviate.util.is_semantic_type" title="Permalink to this definition"></a></dt>
Expand Down
Binary file modified docs/html/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit e36473a

Please sign in to comment.