yalesites-org/ai_feed

该软件包最新版本（1.1.0）没有可用的许可证信息。

提供适合AI摄取的网站内容JSON流。

维护者

详细信息

github.com/yalesites-org/ai_feed

源代码

问题

安装: 26

依赖项: 0

建议者: 0

安全: 0

星级: 0

关注者: 2

分支: 0

开放问题: 0

类型:drupal-module

1.1.0 2024-02-15 15:21 UTC

Unknown License 5128bda99c2eb3c35f1660d4d72a2effd2837f9f

This package is auto-updated.

Last update: 2024-09-22 20:23:02 UTC

README

概述

由耶鲁ITS开发的AI Feed模块旨在创建一个可以被AI搜索服务摄取并生成嵌入内容的网站内容流。该模块利用Drupal查询并准备内容，以便由语言模型集成框架（如LangChain）消费。

功能

  • 检索匿名用户可访问的已发布节点。
  • 处理内容以创建一致且可预期的格式。
  • 生成适合AI搜索服务摄取的网站内容JSON流。
  • 利用Drupal核心和实体相关功能进行内容检索和处理。

流形状

该模块在api/ai/v1/content创建网站内容的端点。目前，此流仅限于匿名用户可访问的已发布节点。未来，这可能包括筛选和新实体类型。JSON的形状如下

{
  "data": [
    {
      "url": "yalesites-yale.edu-node-18",
      "source": "drupal",
      "documentType": "node/page",
      "documentId": 18,
      "documentTitle": "Resources and Workshops",
      "documentUrl": "https://yalesites.yale.edu/resource",
      "documentContent": "...",
      "metaTags": "",
      "metaDescription": "",
      "dateCreated": "2023-10-12T16:09:21+00:00",
      "dateModified": "2023-11-30T16:11:18+00:00",
      "dateProcessed": "2024-01-23T16:05:38+00:00",
    },
    { ... },
  ],
  "links": {
    "first": "https://yalesites.yale.edu/api/ai/v1/content?page=1",
    "prev": "https://yalesites.yale.edu/api/ai/v1/content?page=1",
    "self": "https://yalesites.yale.edu/api/ai/v1/content?page=2",
    "next": "",
    "last": "https://yalesites.yale.edu/api/ai/v1/content?page=2"
  },
  "totals": {
    "total_records": 52,
    "total_pages": 2
  }
}

数据字段

链接字段

总计字段

分页

此API支持分页，每页返回50个结果。默认情况下，如果没有查询参数，API默认为第一页。

使用?page=x查询参数查询不同页面，其中x是一个正整数。

如果没有结果的前一页或下一页，则prev和next URL将是空字符串。

要求

  • Drupal 8或更高版本

贡献/合作

您可以为该模块贡献功能、错误修复或文档。如果您想建议修复或新功能，您可以在GitHub问题队列中添加新问题，或者您可以分叉此存储库并提交拉取请求。有关更多信息，请参阅GitHub关于分叉、分支和拉取请求的文章