Skip to content

Commit e36473a

Browse files
author
Felix Finkbeiner
committed
Update to version 1.0.0rc0 and update documentation
1 parent 49f6647 commit e36473a

File tree

8 files changed

+25
-200
lines changed

8 files changed

+25
-200
lines changed

‎docs/doctrees/environment.pickle‎

-1.6 KB
Binary file not shown.

‎docs/doctrees/index.doctree‎

-28.8 KB
Binary file not shown.

‎docs/html/genindex.html‎

Lines changed: 4 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -35,34 +35,13 @@
3535
<h1 id="index">Index</h1>
3636

3737
<div class="genindex-jumpbox">
38-
<a href="#A"><strong>A</strong></a>
39-
| <a href="#C"><strong>C</strong></a>
40-
| <a href="#E"><strong>E</strong></a>
38+
<a href="#C"><strong>C</strong></a>
4139
| <a href="#G"><strong>G</strong></a>
4240
| <a href="#I"><strong>I</strong></a>
4341
| <a href="#M"><strong>M</strong></a>
44-
| <a href="#Q"><strong>Q</strong></a>
45-
| <a href="#R"><strong>R</strong></a>
46-
| <a href="#T"><strong>T</strong></a>
4742
| <a href="#W"><strong>W</strong></a>
4843

4944
</div>
50-
<h2 id="A">A</h2>
51-
<table style="width: 100%" class="indextable genindextable"><tr>
52-
<td style="width: 33%; vertical-align: top;"><ul>
53-
<li><a href="index.html#weaviate.batch.ActionsBatchRequest">ActionsBatchRequest (class in weaviate.batch)</a>
54-
</li>
55-
<li><a href="index.html#weaviate.batch.ActionsBatchRequest.add_action">add_action() (weaviate.batch.ActionsBatchRequest method)</a>
56-
</li>
57-
</ul></td>
58-
<td style="width: 33%; vertical-align: top;"><ul>
59-
<li><a href="index.html#weaviate.batch.ReferenceBatchRequest.add_reference">add_reference() (weaviate.batch.ReferenceBatchRequest method)</a>
60-
</li>
61-
<li><a href="index.html#weaviate.batch.ThingsBatchRequest.add_thing">add_thing() (weaviate.batch.ThingsBatchRequest method)</a>
62-
</li>
63-
</ul></td>
64-
</tr></table>
65-
6645
<h2 id="C">C</h2>
6746
<table style="width: 100%" class="indextable genindextable"><tr>
6847
<td style="width: 33%; vertical-align: top;"><ul>
@@ -71,29 +50,15 @@ <h2 id="C">C</h2>
7150
</ul></td>
7251
</tr></table>
7352

74-
<h2 id="E">E</h2>
75-
<table style="width: 100%" class="indextable genindextable"><tr>
76-
<td style="width: 33%; vertical-align: top;"><ul>
77-
<li><a href="index.html#weaviate.batch.EntityBatchRequest">EntityBatchRequest (class in weaviate.batch)</a>
78-
</li>
79-
</ul></td>
80-
</tr></table>
81-
8253
<h2 id="G">G</h2>
8354
<table style="width: 100%" class="indextable genindextable"><tr>
8455
<td style="width: 33%; vertical-align: top;"><ul>
8556
<li><a href="index.html#weaviate.util.generate_local_beacon">generate_local_beacon() (in module weaviate.util)</a>
86-
</li>
87-
<li><a href="index.html#weaviate.util.get_domain_from_weaviate_url">get_domain_from_weaviate_url() (in module weaviate.util)</a>
8857
</li>
8958
</ul></td>
9059
<td style="width: 33%; vertical-align: top;"><ul>
91-
<li><a href="index.html#weaviate.batch.ActionsBatchRequest.get_request_body">get_request_body() (weaviate.batch.ActionsBatchRequest method)</a>
92-
93-
<ul>
94-
<li><a href="index.html#weaviate.batch.ThingsBatchRequest.get_request_body">(weaviate.batch.ThingsBatchRequest method)</a>
60+
<li><a href="index.html#weaviate.util.get_domain_from_weaviate_url">get_domain_from_weaviate_url() (in module weaviate.util)</a>
9561
</li>
96-
</ul></li>
9762
<li><a href="index.html#weaviate.util.get_uuid_from_weaviate_url">get_uuid_from_weaviate_url() (in module weaviate.util)</a>
9863
</li>
9964
</ul></td>
@@ -102,6 +67,8 @@ <h2 id="G">G</h2>
10267
<h2 id="I">I</h2>
10368
<table style="width: 100%" class="indextable genindextable"><tr>
10469
<td style="width: 33%; vertical-align: top;"><ul>
70+
<li><a href="index.html#weaviate.util.is_object_url">is_object_url() (in module weaviate.util)</a>
71+
</li>
10572
<li><a href="index.html#weaviate.client.Client.is_reachable">is_reachable() (weaviate.client.Client method)</a>
10673
</li>
10774
</ul></td>
@@ -130,30 +97,6 @@ <h2 id="M">M</h2>
13097
</ul></td>
13198
</tr></table>
13299

133-
<h2 id="Q">Q</h2>
134-
<table style="width: 100%" class="indextable genindextable"><tr>
135-
<td style="width: 33%; vertical-align: top;"><ul>
136-
<li><a href="index.html#weaviate.client.Client.query">query() (weaviate.client.Client method)</a>
137-
</li>
138-
</ul></td>
139-
</tr></table>
140-
141-
<h2 id="R">R</h2>
142-
<table style="width: 100%" class="indextable genindextable"><tr>
143-
<td style="width: 33%; vertical-align: top;"><ul>
144-
<li><a href="index.html#weaviate.batch.ReferenceBatchRequest">ReferenceBatchRequest (class in weaviate.batch)</a>
145-
</li>
146-
</ul></td>
147-
</tr></table>
148-
149-
<h2 id="T">T</h2>
150-
<table style="width: 100%" class="indextable genindextable"><tr>
151-
<td style="width: 33%; vertical-align: top;"><ul>
152-
<li><a href="index.html#weaviate.batch.ThingsBatchRequest">ThingsBatchRequest (class in weaviate.batch)</a>
153-
</li>
154-
</ul></td>
155-
</tr></table>
156-
157100
<h2 id="W">W</h2>
158101
<table style="width: 100%" class="indextable genindextable"><tr>
159102
<td style="width: 33%; vertical-align: top;"><ul>

‎docs/html/index.html‎

Lines changed: 18 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -48,145 +48,9 @@
4848
</dl>
4949
</dd></dl>
5050

51-
<dl class="py method">
52-
<dt id="weaviate.client.Client.query">
53-
<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>
54-
<dd><dl class="simple">
55-
<dt>Allows to send simple graph QL string queries.</dt><dd><p>To create more complex GQL queries please use a GQL python client.
56-
Be cautious of injection risks when generating query strings.</p>
57-
</dd>
58-
</dl>
59-
<dl class="field-list simple">
60-
<dt class="field-odd">Parameters</dt>
61-
<dd class="field-odd"><p><strong>gql_query</strong> (<em>str</em>) – A GQL query in form of a string</p>
62-
</dd>
63-
<dt class="field-even">Returns</dt>
64-
<dd class="field-even"><p>Data response of the query</p>
65-
</dd>
66-
<dt class="field-odd">Raises</dt>
67-
<dd class="field-odd"><p>TypeError: If parameter has the wrong type.
68-
ConnectionError: if the network connection to weaviate fails.
69-
UnexpectedStatusCodeException: if weaviate reports a none OK status.</p>
70-
</dd>
71-
</dl>
72-
</dd></dl>
73-
74-
</dd></dl>
75-
76-
<span class="target" id="module-weaviate.batch"></span><dl class="py class">
77-
<dt id="weaviate.batch.ActionsBatchRequest">
78-
<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>
79-
<dd><p>Collect things for one batch request to weaviate.
80-
Caution this batch will not be validated through weaviate.</p>
81-
<dl class="py method">
82-
<dt id="weaviate.batch.ActionsBatchRequest.add_action">
83-
<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>
84-
<dd><p>Add an action to this batch</p>
85-
<dl class="field-list simple">
86-
<dt class="field-odd">Parameters</dt>
87-
<dd class="field-odd"><ul class="simple">
88-
<li><p><strong>action</strong> (<em>dict</em>) – that should be added as part of the batch.</p></li>
89-
<li><p><strong>class_name</strong> (<em>str</em>) – class of the action.</p></li>
90-
<li><p><strong>uuid</strong> (<em>str</em>) – if given the thing will be added under this uuid.</p></li>
91-
</ul>
92-
</dd>
93-
<dt class="field-even">Raises</dt>
94-
<dd class="field-even"><p>TypeError, ValueError</p>
95-
</dd>
96-
</dl>
97-
</dd></dl>
98-
99-
<dl class="py method">
100-
<dt id="weaviate.batch.ActionsBatchRequest.get_request_body">
101-
<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>
102-
<dd><p>Get the request body as it is needed for weaviate</p>
103-
<dl class="field-list simple">
104-
<dt class="field-odd">Returns</dt>
105-
<dd class="field-odd"><p>the request body as a dict</p>
106-
</dd>
107-
</dl>
108-
</dd></dl>
109-
110-
</dd></dl>
111-
112-
<dl class="py class">
113-
<dt id="weaviate.batch.EntityBatchRequest">
114-
<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>
115-
<dd><p>Base for storing entities</p>
116-
</dd></dl>
117-
118-
<dl class="py class">
119-
<dt id="weaviate.batch.ReferenceBatchRequest">
120-
<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>
121-
<dd><p>Collect references to add them in one request to weaviate.
122-
Caution this request will miss some validations to be faster.</p>
123-
<dl class="py method">
124-
<dt id="weaviate.batch.ReferenceBatchRequest.add_reference">
125-
<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>
126-
<dd><p>Add one reference to this batch</p>
127-
<dl class="field-list simple">
128-
<dt class="field-odd">Parameters</dt>
129-
<dd class="field-odd"><ul class="simple">
130-
<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>
131-
<li><p><strong>from_entity_class_name</strong> (<em>str</em>) – The name of the class that should reference another entity.</p></li>
132-
<li><p><strong>from_property_name</strong> (<em>str</em>) – The name of the property that contains the reference.</p></li>
133-
<li><p><strong>to_entity_uuid</strong> (<em>str</em>) – The UUID or URL of the thing that is actually referenced.</p></li>
134-
<li><p><strong>from_semantic_type</strong> (<em>str</em>) – Either things or actions.
135-
Defaults to things.
136-
Settable through the constants SEMANTIC_TYPE_THINGS and SEMANTIC_TYPE_ACTIONS</p></li>
137-
<li><p><strong>to_semantic_type</strong> (<em>str</em>) – Either things or actions.
138-
Defaults to things.
139-
Settable through the constants SEMANTIC_TYPE_THINGS and SEMANTIC_TYPE_ACTIONS</p></li>
140-
</ul>
141-
</dd>
142-
<dt class="field-even">Returns</dt>
143-
<dd class="field-even"><p>None if successful</p>
144-
</dd>
145-
<dt class="field-odd">Raises</dt>
146-
<dd class="field-odd"><p>TypeError: If arguments are not string.</p>
147-
</dd>
148-
</dl>
149-
</dd></dl>
150-
15151
</dd></dl>
15252

153-
<dl class="py class">
154-
<dt id="weaviate.batch.ThingsBatchRequest">
155-
<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>
156-
<dd><p>Collect things for one batch request to weaviate.
157-
Caution this batch will not be validated through weaviate.</p>
158-
<dl class="py method">
159-
<dt id="weaviate.batch.ThingsBatchRequest.add_thing">
160-
<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>
161-
<dd><p>Add a thing to this batch</p>
162-
<dl class="field-list simple">
163-
<dt class="field-odd">Parameters</dt>
164-
<dd class="field-odd"><ul class="simple">
165-
<li><p><strong>thing</strong> (<em>dict</em>) – that should be added as part of the batch.</p></li>
166-
<li><p><strong>class_name</strong> (<em>str</em>) – class of the thing.</p></li>
167-
<li><p><strong>uuid</strong> (<em>str</em>) – if given the thing will be added under this uuid.</p></li>
168-
</ul>
169-
</dd>
170-
<dt class="field-even">Raises</dt>
171-
<dd class="field-even"><p>TypeError, ValueError</p>
172-
</dd>
173-
</dl>
174-
</dd></dl>
175-
176-
<dl class="py method">
177-
<dt id="weaviate.batch.ThingsBatchRequest.get_request_body">
178-
<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>
179-
<dd><p>Get the request body as it is needed for weaviate</p>
180-
<dl class="field-list simple">
181-
<dt class="field-odd">Returns</dt>
182-
<dd class="field-odd"><p>the request body as a dict</p>
183-
</dd>
184-
</dl>
185-
</dd></dl>
186-
187-
</dd></dl>
188-
189-
<span class="target" id="module-weaviate.util"></span><dl class="py function">
53+
<span class="target" id="module-weaviate.batch"></span><span class="target" id="module-weaviate.util"></span><dl class="py function">
19054
<dt id="weaviate.util.generate_local_beacon">
19155
<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>
19256
<dd><p>Generates a beacon to the given schema class type with the given uuid.</p>
@@ -231,6 +95,23 @@
23195
</dl>
23296
</dd></dl>
23397

98+
<dl class="py function">
99+
<dt id="weaviate.util.is_object_url">
100+
<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>
101+
<dd><dl class="simple">
102+
<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>
103+
</dd>
104+
</dl>
105+
<dl class="field-list simple">
106+
<dt class="field-odd">Parameters</dt>
107+
<dd class="field-odd"><p><strong>input</strong> (<em>str</em>) – </p>
108+
</dd>
109+
<dt class="field-even">Returns</dt>
110+
<dd class="field-even"><p></p>
111+
</dd>
112+
</dl>
113+
</dd></dl>
114+
234115
<dl class="py function">
235116
<dt id="weaviate.util.is_semantic_type">
236117
<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>

‎docs/html/objects.inv‎

-79 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)