Skip to content

Commit 9efc042

Browse files
ian-at-airbytegithub-actions[bot]
authored andcommitted
docs: sync agent connector docs from airbyte-agent-connectors repo
1 parent 32dbfcc commit 9efc042

146 files changed

Lines changed: 2796 additions & 2432 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/ai-agents/connectors/airtable/AUTH.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ This authentication method isn't available for this connector.
2222
Example request:
2323

2424
```python
25-
from airbyte_agent_airtable import AirtableConnector
26-
from airbyte_agent_airtable.models import AirtableAuthConfig
25+
from airbyte_agent_sdk.connectors.airtable import AirtableConnector
26+
from airbyte_agent_sdk.connectors.airtable.models import AirtableAuthConfig
2727

2828
connector = AirtableConnector(
2929
auth_config=AirtableAuthConfig(
@@ -60,7 +60,7 @@ curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
6060
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
6161
-H "Content-Type: application/json" \
6262
-d '{
63-
"customer_name": "<CUSTOMER_NAME>",
63+
"workspace_name": "<WORKSPACE_NAME>",
6464
"connector_type": "Airtable",
6565
"name": "My Airtable Connector",
6666
"credentials": {
@@ -77,11 +77,11 @@ If your Airbyte client can access multiple organizations, include `organization_
7777
**Python SDK**
7878

7979
```python
80-
from airbyte_agent_airtable import AirtableConnector, AirbyteAuthConfig
80+
from airbyte_agent_sdk.connectors.airtable import AirtableConnector, AirbyteAuthConfig
8181

8282
connector = AirtableConnector(
8383
auth_config=AirbyteAuthConfig(
84-
customer_name="<your_customer_name>",
84+
workspace_name="<your_workspace_name>",
8585
organization_id="<your_organization_id>", # Optional for multi-org clients
8686
airbyte_client_id="<your-client-id>",
8787
airbyte_client_secret="<your-client-secret>"

docs/ai-agents/connectors/airtable/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Airtable connector isn't currently able to handle prompts like these.
3434
## Installation
3535

3636
```bash
37-
uv pip install airbyte-agent-airtable
37+
uv pip install airbyte-agent-sdk
3838
```
3939

4040
## Usage
@@ -46,8 +46,8 @@ Connectors can run in open source or hosted mode.
4646
In open source mode, you provide API credentials directly to the connector.
4747

4848
```python
49-
from airbyte_agent_airtable import AirtableConnector
50-
from airbyte_agent_airtable.models import AirtableAuthConfig
49+
from airbyte_agent_sdk.connectors.airtable import AirtableConnector
50+
from airbyte_agent_sdk.connectors.airtable.models import AirtableAuthConfig
5151

5252
connector = AirtableConnector(
5353
auth_config=AirtableAuthConfig(
@@ -69,11 +69,11 @@ If your Airbyte client can access multiple organizations, also set `organization
6969
This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
7070

7171
```python
72-
from airbyte_agent_airtable import AirtableConnector, AirbyteAuthConfig
72+
from airbyte_agent_sdk.connectors.airtable import AirtableConnector, AirbyteAuthConfig
7373

7474
connector = AirtableConnector(
7575
auth_config=AirbyteAuthConfig(
76-
customer_name="<your_customer_name>",
76+
workspace_name="<your_workspace_name>",
7777
organization_id="<your_organization_id>", # Optional for multi-org clients
7878
airbyte_client_id="<your-client-id>",
7979
airbyte_client_secret="<your-client-secret>"
@@ -94,8 +94,8 @@ This connector supports the following entities and actions. For more details, se
9494

9595
| Entity | Actions |
9696
|--------|---------|
97-
| Bases | [List](./REFERENCE.md#bases-list), [Search](./REFERENCE.md#bases-search) |
98-
| Tables | [List](./REFERENCE.md#tables-list), [Search](./REFERENCE.md#tables-search) |
97+
| Bases | [List](./REFERENCE.md#bases-list), [Context Store Search](./REFERENCE.md#bases-context-store-search) |
98+
| Tables | [List](./REFERENCE.md#tables-list), [Context Store Search](./REFERENCE.md#tables-context-store-search) |
9999
| Records | [List](./REFERENCE.md#records-list), [Get](./REFERENCE.md#records-get) |
100100

101101

@@ -109,7 +109,7 @@ See the official [Airtable API reference](https://airtable.com/developers/web/ap
109109

110110
## Version information
111111

112-
- **Package version:** 0.1.51
113-
- **Connector version:** 1.0.6
114-
- **Generated with Connector SDK commit SHA:** 75f388847745be753ab20224c66697e1d4a84347
112+
- **Package version:** 1.0.8
113+
- **Connector version:** 1.0.8
114+
- **Generated with Connector SDK commit SHA:** unknown
115115
- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/airtable/CHANGELOG.md)

docs/ai-agents/connectors/airtable/REFERENCE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The Airtable connector supports the following entities and actions.
88

99
| Entity | Actions |
1010
|--------|---------|
11-
| Bases | [List](#bases-list), [Search](#bases-search) |
12-
| Tables | [List](#tables-list), [Search](#tables-search) |
11+
| Bases | [List](#bases-list), [Context Store Search](#bases-context-store-search) |
12+
| Tables | [List](#tables-list), [Context Store Search](#tables-context-store-search) |
1313
| Records | [List](#records-list), [Get](#records-get) |
1414

1515
## Bases
@@ -58,14 +58,14 @@ curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_con
5858

5959
</details>
6060

61-
### Bases Search
61+
### Bases Context Store Search
6262

6363
Search and filter bases records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
6464

6565
#### Python SDK
6666

6767
```python
68-
await airtable.bases.search(
68+
await airtable.bases.context_store_search(
6969
query={"filter": {"eq": {"id": "<str>"}}}
7070
)
7171
```
@@ -78,7 +78,7 @@ curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_con
7878
--header 'Authorization: Bearer {your_auth_token}' \
7979
--data '{
8080
"entity": "bases",
81-
"action": "search",
81+
"action": "context_store_search",
8282
"params": {
8383
"query": {"filter": {"eq": {"id": "<str>"}}}
8484
}
@@ -180,14 +180,14 @@ curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_con
180180

181181
</details>
182182

183-
### Tables Search
183+
### Tables Context Store Search
184184

185185
Search and filter tables records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
186186

187187
#### Python SDK
188188

189189
```python
190-
await airtable.tables.search(
190+
await airtable.tables.context_store_search(
191191
query={"filter": {"eq": {"id": "<str>"}}}
192192
)
193193
```
@@ -200,7 +200,7 @@ curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_con
200200
--header 'Authorization: Bearer {your_auth_token}' \
201201
--data '{
202202
"entity": "tables",
203-
"action": "search",
203+
"action": "context_store_search",
204204
"params": {
205205
"query": {"filter": {"eq": {"id": "<str>"}}}
206206
}

docs/ai-agents/connectors/amazon-ads/AUTH.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ In open source mode, you provide API credentials directly to the connector.
2222
Example request:
2323

2424
```python
25-
from airbyte_agent_amazon_ads import AmazonAdsConnector
26-
from airbyte_agent_amazon_ads.models import AmazonAdsAuthConfig
25+
from airbyte_agent_sdk.connectors.amazon_ads import AmazonAdsConnector
26+
from airbyte_agent_sdk.connectors.amazon_ads.models import AmazonAdsAuthConfig
2727

2828
connector = AmazonAdsConnector(
2929
auth_config=AmazonAdsAuthConfig(
@@ -60,7 +60,7 @@ curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
6060
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
6161
-H "Content-Type: application/json" \
6262
-d '{
63-
"customer_name": "<CUSTOMER_NAME>",
63+
"workspace_name": "<WORKSPACE_NAME>",
6464
"connector_type": "Amazon-Ads",
6565
"name": "My Amazon-Ads Connector",
6666
"credentials": {
@@ -82,7 +82,7 @@ Request a consent URL for your user.
8282

8383
| Field Name | Type | Required | Description |
8484
|------------|------|----------|-------------|
85-
| `customer_name` | `string` | Yes | Your unique identifier for the customer |
85+
| `workspace_name` | `string` | Yes | Your unique identifier for the workspace |
8686
| `connector_type` | `string` | Yes | The connector type (e.g., "Amazon-Ads") |
8787
| `redirect_url` | `string` | Yes | URL to redirect to after OAuth authorization |
8888

@@ -93,7 +93,7 @@ curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors/oauth/initia
9393
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
9494
-H "Content-Type: application/json" \
9595
-d '{
96-
"customer_name": "<CUSTOMER_NAME>",
96+
"workspace_name": "<WORKSPACE_NAME>",
9797
"connector_type": "Amazon-Ads",
9898
"redirect_url": "https://yourapp.com/oauth/callback"
9999
}'
@@ -122,11 +122,11 @@ If your Airbyte client can access multiple organizations, include `organization_
122122
**Python SDK**
123123

124124
```python
125-
from airbyte_agent_amazon_ads import AmazonAdsConnector, AirbyteAuthConfig
125+
from airbyte_agent_sdk.connectors.amazon_ads import AmazonAdsConnector, AirbyteAuthConfig
126126

127127
connector = AmazonAdsConnector(
128128
auth_config=AirbyteAuthConfig(
129-
customer_name="<your_customer_name>",
129+
workspace_name="<your_workspace_name>",
130130
organization_id="<your_organization_id>", # Optional for multi-org clients
131131
airbyte_client_id="<your-client-id>",
132132
airbyte_client_secret="<your-client-secret>"

docs/ai-agents/connectors/amazon-ads/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The Amazon-Ads connector isn't currently able to handle prompts like these.
3131
## Installation
3232

3333
```bash
34-
uv pip install airbyte-agent-amazon-ads
34+
uv pip install airbyte-agent-sdk
3535
```
3636

3737
## Usage
@@ -43,8 +43,8 @@ Connectors can run in open source or hosted mode.
4343
In open source mode, you provide API credentials directly to the connector.
4444

4545
```python
46-
from airbyte_agent_amazon_ads import AmazonAdsConnector
47-
from airbyte_agent_amazon_ads.models import AmazonAdsAuthConfig
46+
from airbyte_agent_sdk.connectors.amazon_ads import AmazonAdsConnector
47+
from airbyte_agent_sdk.connectors.amazon_ads.models import AmazonAdsAuthConfig
4848

4949
connector = AmazonAdsConnector(
5050
auth_config=AmazonAdsAuthConfig(
@@ -68,11 +68,11 @@ If your Airbyte client can access multiple organizations, also set `organization
6868
This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
6969

7070
```python
71-
from airbyte_agent_amazon_ads import AmazonAdsConnector, AirbyteAuthConfig
71+
from airbyte_agent_sdk.connectors.amazon_ads import AmazonAdsConnector, AirbyteAuthConfig
7272

7373
connector = AmazonAdsConnector(
7474
auth_config=AirbyteAuthConfig(
75-
customer_name="<your_customer_name>",
75+
workspace_name="<your_workspace_name>",
7676
organization_id="<your_organization_id>", # Optional for multi-org clients
7777
airbyte_client_id="<your-client-id>",
7878
airbyte_client_secret="<your-client-secret>"
@@ -93,7 +93,7 @@ This connector supports the following entities and actions. For more details, se
9393

9494
| Entity | Actions |
9595
|--------|---------|
96-
| Profiles | [List](./REFERENCE.md#profiles-list), [Get](./REFERENCE.md#profiles-get), [Search](./REFERENCE.md#profiles-search) |
96+
| Profiles | [List](./REFERENCE.md#profiles-list), [Get](./REFERENCE.md#profiles-get), [Context Store Search](./REFERENCE.md#profiles-context-store-search) |
9797
| Portfolios | [List](./REFERENCE.md#portfolios-list), [Get](./REFERENCE.md#portfolios-get) |
9898
| Sponsored Product Campaigns | [List](./REFERENCE.md#sponsored-product-campaigns-list), [Get](./REFERENCE.md#sponsored-product-campaigns-get) |
9999

@@ -108,7 +108,7 @@ See the official [Amazon-Ads API reference](https://advertising.amazon.com/API/d
108108

109109
## Version information
110110

111-
- **Package version:** 0.1.70
112-
- **Connector version:** 1.0.9
113-
- **Generated with Connector SDK commit SHA:** 75f388847745be753ab20224c66697e1d4a84347
111+
- **Package version:** 1.0.10
112+
- **Connector version:** 1.0.10
113+
- **Generated with Connector SDK commit SHA:** unknown
114114
- **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/amazon-ads/CHANGELOG.md)

docs/ai-agents/connectors/amazon-ads/REFERENCE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Amazon-Ads connector supports the following entities and actions.
88

99
| Entity | Actions |
1010
|--------|---------|
11-
| Profiles | [List](#profiles-list), [Get](#profiles-get), [Search](#profiles-search) |
11+
| Profiles | [List](#profiles-list), [Get](#profiles-get), [Context Store Search](#profiles-context-store-search) |
1212
| Portfolios | [List](#portfolios-list), [Get](#portfolios-get) |
1313
| Sponsored Product Campaigns | [List](#sponsored-product-campaigns-list), [Get](#sponsored-product-campaigns-get) |
1414

@@ -121,14 +121,14 @@ curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_con
121121

122122
</details>
123123

124-
### Profiles Search
124+
### Profiles Context Store Search
125125

126126
Search and filter profiles records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
127127

128128
#### Python SDK
129129

130130
```python
131-
await amazon_ads.profiles.search(
131+
await amazon_ads.profiles.context_store_search(
132132
query={"filter": {"eq": {"accountInfo": {}}}}
133133
)
134134
```
@@ -141,7 +141,7 @@ curl --location 'https://api.airbyte.ai/api/v1/integrations/connectors/{your_con
141141
--header 'Authorization: Bearer {your_auth_token}' \
142142
--data '{
143143
"entity": "profiles",
144-
"action": "search",
144+
"action": "context_store_search",
145145
"params": {
146146
"query": {"filter": {"eq": {"accountInfo": {}}}}
147147
}

docs/ai-agents/connectors/amazon-seller-partner/AUTH.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ In open source mode, you provide API credentials directly to the connector.
2323
Example request:
2424

2525
```python
26-
from airbyte_agent_amazon_seller_partner import AmazonSellerPartnerConnector
27-
from airbyte_agent_amazon_seller_partner.models import AmazonSellerPartnerAuthConfig
26+
from airbyte_agent_sdk.connectors.amazon_seller_partner import AmazonSellerPartnerConnector
27+
from airbyte_agent_sdk.connectors.amazon_seller_partner.models import AmazonSellerPartnerAuthConfig
2828

2929
connector = AmazonSellerPartnerConnector(
3030
auth_config=AmazonSellerPartnerAuthConfig(
@@ -69,7 +69,7 @@ curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
6969
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
7070
-H "Content-Type: application/json" \
7171
-d '{
72-
"customer_name": "<CUSTOMER_NAME>",
72+
"workspace_name": "<WORKSPACE_NAME>",
7373
"connector_type": "Amazon-Seller-Partner",
7474
"name": "My Amazon-Seller-Partner Connector",
7575
"credentials": {
@@ -95,7 +95,7 @@ Request a consent URL for your user.
9595

9696
| Field Name | Type | Required | Description |
9797
|------------|------|----------|-------------|
98-
| `customer_name` | `string` | Yes | Your unique identifier for the customer |
98+
| `workspace_name` | `string` | Yes | Your unique identifier for the workspace |
9999
| `connector_type` | `string` | Yes | The connector type (e.g., "Amazon-Seller-Partner") |
100100
| `redirect_url` | `string` | Yes | URL to redirect to after OAuth authorization |
101101

@@ -106,7 +106,7 @@ curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors/oauth/initia
106106
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
107107
-H "Content-Type: application/json" \
108108
-d '{
109-
"customer_name": "<CUSTOMER_NAME>",
109+
"workspace_name": "<WORKSPACE_NAME>",
110110
"connector_type": "Amazon-Seller-Partner",
111111
"redirect_url": "https://yourapp.com/oauth/callback"
112112
}'
@@ -135,11 +135,11 @@ If your Airbyte client can access multiple organizations, include `organization_
135135
**Python SDK**
136136

137137
```python
138-
from airbyte_agent_amazon_seller_partner import AmazonSellerPartnerConnector, AirbyteAuthConfig
138+
from airbyte_agent_sdk.connectors.amazon_seller_partner import AmazonSellerPartnerConnector, AirbyteAuthConfig
139139

140140
connector = AmazonSellerPartnerConnector(
141141
auth_config=AirbyteAuthConfig(
142-
customer_name="<your_customer_name>",
142+
workspace_name="<your_workspace_name>",
143143
organization_id="<your_organization_id>", # Optional for multi-org clients
144144
airbyte_client_id="<your-client-id>",
145145
airbyte_client_secret="<your-client-secret>"

0 commit comments

Comments
 (0)