跳到主要内容

Airbyte Zendesk Support(已弃用)

注意:此特定于连接器的加载器已弃用。请改用 AirbyteLoader

Airbyte 是一个数据集成平台,用于将来自 API、数据库和文件的 ELT 管道连接到数据仓库和湖。它拥有最大的 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 参考:文档

增量加载

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

要利用此功能,请存储加载器的 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()

此页面是否有帮助?