You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-33Lines changed: 18 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,17 @@ Developers will need to create an API Key within your [Developer Portal](https:/
13
13
14
14
The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.
15
15
16
-
<!-- Start SDK Installation -->
16
+
<!-- Start SDK Installation [installation] -->
17
17
## SDK Installation
18
18
19
19
```bash
20
20
pip install airbyte-api
21
21
```
22
-
<!-- End SDK Installation -->
22
+
<!-- End SDK Installation [installation] -->
23
23
24
+
<!-- Start SDK Example Usage [usage] -->
24
25
## SDK Example Usage
25
-
<!-- Start SDK Example Usage -->
26
+
26
27
### Example
27
28
28
29
```python
@@ -68,12 +69,11 @@ if res.connection_response is not None:
68
69
# handle response
69
70
pass
70
71
```
71
-
<!-- End SDK Example Usage -->
72
+
<!-- End SDK Example Usage [usage] -->
72
73
73
-
<!-- Start SDK Available Operations -->
74
+
<!-- Start Available Resources and Operations [operations]-->
*[create_connection](docs/sdks/connections/README.md#create_connection) - Create a connection
@@ -120,29 +120,15 @@ if res.connection_response is not None:
120
120
*[get_workspace](docs/sdks/workspaces/README.md#get_workspace) - Get Workspace details
121
121
*[list_workspaces](docs/sdks/workspaces/README.md#list_workspaces) - List workspaces
122
122
*[update_workspace](docs/sdks/workspaces/README.md#update_workspace) - Update a workspace
123
-
<!-- End SDK Available Operations -->
124
-
125
-
126
-
127
-
<!-- Start Dev Containers -->
123
+
<!-- End Available Resources and Operations [operations] -->
128
124
129
-
<!-- End Dev Containers -->
130
125
131
126
132
127
133
-
<!-- Start Pagination -->
134
-
# Pagination
135
128
136
-
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
137
-
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
138
-
return value of `Next` is `None`, then there are no more pages to be fetched.
139
129
140
-
Here's an example of one such pagination call:
141
-
<!-- End Pagination -->
142
130
143
-
144
-
145
-
<!-- Start Error Handling -->
131
+
<!-- Start Error Handling [errors] -->
146
132
## Error Handling
147
133
148
134
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
@@ -312,11 +297,11 @@ if res.connection_response is not None:
312
297
# handle response
313
298
pass
314
299
```
315
-
<!-- End Server Selection -->
300
+
<!-- End Server Selection [server] -->
316
301
317
302
318
303
319
-
<!-- Start Custom HTTP Client -->
304
+
<!-- Start Custom HTTP Client [http-client] -->
320
305
## Custom HTTP Client
321
306
322
307
The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
|`additional_headers`| List[[shared.Header](../../models/shared/header.md)]|:heavy_minus_sign:| Additional HTTP headers to send with every request. |[object Object]|
10
+
|`additional_headers`| List[[shared.Header](../../models/shared/header.md)]|:heavy_minus_sign:| Additional HTTP headers to send with every request. |{"header_key":"X-OpenAI-Api-Key","value":"my-openai-api-key"}|
|`batch_size`|*Optional[int]*|:heavy_minus_sign:| The number of records to send to Weaviate in each batch ||
13
13
|`default_vectorizer`|[Optional[shared.DefaultVectorizer]](../../models/shared/defaultvectorizer.md)|:heavy_minus_sign:| The vectorizer to use if new classes need to be created ||
0 commit comments