跳到主要内容
Open In ColabOpen on GitHub

Airbyte Zendesk Support (已弃用)

注意：此连接器专用加载器已弃用。请改用 AirbyteLoader。

Airbyte 是一个数据集成平台，用于将来自 API、数据库和文件的数据传输到数据仓库和数据湖。它拥有最大的 ELT 连接器目录，可连接到各种数据仓库和数据库。

该加载器将 Zendesk Support 连接器作为文档加载器公开，允许您将各种对象作为文档加载。

安装​

首先，您需要安装 airbyte-source-zendesk-support Python 包。

%pip install --upgrade --quiet  airbyte-source-zendesk-support

示例​

有关如何配置读取器的详细信息，请查看 Airbyte 文档页面。配置对象应遵循的 JSON 模式可在 Github 上找到：https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-zendesk-support/source_zendesk_support/spec.json。

一般形式如下

{
  "subdomain": "<your zendesk subdomain>",
  "start_date": "<date from which to start retrieving records from in ISO format, e.g. 2020-10-20T00:00:00Z>",
  "credentials": {
    "credentials": "api_token",
    "email": "<your email>",
    "api_token": "<your api token>"
  }
}

默认情况下，所有字段都作为元数据存储在文档中，文本内容被设置为空字符串。通过转换读取器返回的文档来构建文档的文本内容。

from langchain_community.document_loaders.airbyte import AirbyteZendeskSupportLoader

config = {
    # your zendesk-support configuration
}

loader = AirbyteZendeskSupportLoader(
    config=config, stream_name="tickets"
)  # check the documentation linked above for a list of all streams

现在您可以按常规方式加载文档

docs = loader.load()

由于 `load` 返回一个列表，它将阻塞直到所有文档加载完毕。为了更好地控制此过程，您也可以使用 `lazy_load` 方法，它会返回一个迭代器。

docs_iterator = loader.lazy_load()

请记住，默认情况下页面内容为空，元数据对象包含记录中的所有信息。要以不同方式创建文档，请在创建加载器时传入一个 `record_handler` 函数。

from langchain_core.documents import Document


def handle_record(record, id):
    return Document(page_content=record.data["title"], metadata=record.data)


loader = AirbyteZendeskSupportLoader(
    config=config, record_handler=handle_record, stream_name="tickets"
)
docs = loader.load()
API 参考：Document

增量加载​

某些流支持增量加载，这意味着源会跟踪已同步的记录，并且不会再次加载它们。这对于数据量大且频繁更新的源非常有用。

为了利用此功能，请存储加载器的 `last_state` 属性，并在再次创建加载器时传入该属性。这将确保只加载新记录。

last_state = loader.last_state  # store safely

incremental_loader = AirbyteZendeskSupportLoader(
    config=config, stream_name="tickets", state=last_state
)

new_docs = incremental_loader.load()