Faradai DecarbonAI Lite

Faradai DecarbonAI Lite · GPT Actions

Sustainability Context Document Search

API for searching context documents related to sustainability.

  • GET /searchSearch Sustainability Documents
原始 API 定义
{
  "openapi": "3.1.0",
  "info": {
    "title": "Sustainability Context Document Search",
    "version": "1.0.0",
    "description": "API for searching context documents related to sustainability."
  },
  "servers": [
    {
      "url": " https://sustainapp.faradai.ai/backend/API/AIAssistant",
      "description": "Reengen Carbon Development Server"
    }
  ],
  "paths": {
    "/search": {
      "get": {
        "summary": "Search Sustainability Documents",
        "operationId": "searchSustainabilityDocuments",
        "tags": [
          "Sustainability"
        ],
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search query for finding sustainability context documents.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with context documents.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ContextDocument"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid request or query parameter."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ContextDocument": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "Title of the document."
          },
          "url": {
            "type": "string",
            "format": "uri",
            "description": "URL of the document."
          },
          "summary": {
            "type": "string",
            "description": "Brief summary of the document."
          }
        }
      }
    }
  }
}