apitable_devbook_knowledge_graph.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Requirement already satisfied: neo4j in ./.venv/lib/python3.11/site-packages (5.13.0)\n",
      "Requirement already satisfied: pytz in ./.venv/lib/python3.11/site-packages (from neo4j) (2023.3.post1)\n"
     ]
    }
   ],
   "source": [
    "!pip install neo4j"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "from langchain.graphs import Neo4jGraph\n",
    "\n",
    "url = \"neo4j+s://xxxx.databases.neo4j.io\"\n",
    "username =\"neo4j\"\n",
    "password = \"xxxxx\"\n",
    "graph = Neo4jGraph(\n",
    "    url=url,\n",
    "    username=username,\n",
    "    password=password\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [],
   "source": [
    "import yaml\n",
    "from langchain.graphs.graph_document import (\n",
    "    Node,\n",
    "    Relationship,\n",
    "    GraphDocument,\n",
    ")\n",
    "from langchain.docstore.document import Document\n",
    "from typing import List\n",
    "import json\n",
    "\n",
    "# Open the OpenAPI YAML file\n",
    "with open(\"openapi.yaml\", \"r\") as file:\n",
    "    # Load the YAML file using the PyYAML library\n",
    "    openapi_data = yaml.safe_load(file)\n",
    "\n",
    "node_list: List[Node] = []\n",
    "edge_list: List[Relationship] = []\n",
    "\n",
    "# 添加端点（Endpoint）作为节点，并添加属性\n",
    "for path, details in openapi_data[\"paths\"].items():\n",
    "    for method, operation in details.items():\n",
    "        operation_id = operation.get(\"operationId\")\n",
    "        parameters = operation.get(\"parameters\")\n",
    "        # 添加端点节点及其属性\n",
    "        node = Node(\n",
    "            id=operation_id,\n",
    "            type=\"Endpoint\",\n",
    "            properties={\n",
    "                \"path\": path,\n",
    "                \"method\": method.upper(),\n",
    "                \"parameters\": json.dumps(parameters),\n",
    "            },\n",
    "        )\n",
    "        node_list.append(node)\n",
    "\n",
    "# 添加模型（Schema）作为节点，并添加属性\n",
    "for schema, origin_properties in openapi_data[\"components\"][\"schemas\"].items():\n",
    "    properties = origin_properties.get(\"properties\")\n",
    "    description = origin_properties.get(\"description\", \"\")\n",
    "    allOf = origin_properties.get(\"allOf\", [])\n",
    "    # 添加模型节点及其属性\n",
    "    node = Node(\n",
    "        id=schema,\n",
    "        type=\"Schema\",\n",
    "        properties={\n",
    "            \"description\": description,\n",
    "            \"allOf\": json.dumps(allOf),\n",
    "            \"properties\": json.dumps(properties),\n",
    "        },\n",
    "    )\n",
    "    node_list.append(node)\n",
    "\n",
    "# 添加边及其属性\n",
    "for path, details in openapi_data[\"paths\"].items():\n",
    "    for method, operation in details.items():\n",
    "        operation_id = operation.get(\"operationId\")\n",
    "\n",
    "        responses = operation.get(\"responses\", {})\n",
    "        for status_code, response in responses.items():\n",
    "            schema_ref = (\n",
    "                response.get(\"content\", {})\n",
    "                .get(\"application/json\", {})\n",
    "                .get(\"schema\", {})\n",
    "                .get(\"$ref\")\n",
    "            )\n",
    "            if schema_ref:\n",
    "                schema = schema_ref.split(\"/\")[-1]\n",
    "                # 查找源节点和目标节点\n",
    "                source_node = next((node for node in node_list if node.id == operation_id), None)\n",
    "                target_node = next((node for node in node_list if node.id == schema), None)\n",
    "                if source_node and target_node:\n",
    "                    # 添加边及其属性\n",
    "                    edge = Relationship(\n",
    "                        source=source_node,\n",
    "                        target=target_node,\n",
    "                        type=f\"Response_{status_code}\",\n",
    "                        properties={},\n",
    "                    )\n",
    "                    edge_list.append(edge)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [],
   "source": [
    "graph_document = GraphDocument(\n",
    "    nodes = node_list,\n",
    "    relationships = edge_list,\n",
    "    source = Document(page_content=str(openapi_data), metadata={})\n",
    ")\n",
    "# Store information into a graph\n",
    "graph.add_graph_documents([graph_document])"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "metadata": {},
   "outputs": [],
   "source": [
    "from langchain.chains import GraphCypherQAChain\n",
    "\n",
    "from langchain.chat_models import AzureChatOpenAI\n",
    "\n",
    "graph.refresh_schema()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 19,
   "metadata": {},
   "outputs": [],
   "source": [
    "cypher_chain = GraphCypherQAChain.from_llm(\n",
    "    graph=graph,\n",
    "    cypher_llm=AzureChatOpenAI(temperature=0, deployment_name=\"gpt-4\"),\n",
    "    qa_llm=AzureChatOpenAI(temperature=0, deployment_name=\"gpt-35-turbo-16k\"),\n",
    "    validate_cypher=True, # Validate relationship directions\n",
    "    verbose=True\n",
    ")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 20,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "\n",
      "\u001b[1m> Entering new GraphCypherQAChain chain...\u001b[0m\n",
      "Generated Cypher:\n",
      "\u001b[32;1m\u001b[1;3mMATCH (e:Endpoint)-[r:RESPONSE_200]->(s:Schema) RETURN e, r, s\u001b[0m\n",
      "Full Context:\n",
      "\u001b[32;1m\u001b[1;3m[{'e': {'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'GET', 'id': 'get-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"pageSize\", \"required\": false, \"in\": \"query\", \"example\": 100, \"description\": \"How many records are returned per page. By default, 100 records are returned per page. The value range is an integer from 1 to 1000.\", \"schema\": {\"default\": 100, \"type\": \"number\"}}, {\"name\": \"maxRecords\", \"required\": false, \"in\": \"query\", \"example\": 1000, \"description\": \"How many records are returned in total. If maxRecords and pageSize are used at the same time, and the value of maxRecords is less than the total number of records, only the setting of maxRecords will take effect.\", \"schema\": {\"type\": \"number\"}}, {\"name\": \"pageNum\", \"required\": false, \"in\": \"query\", \"example\": 1, \"description\": \"Specifies the page number of the page, which is used in conjunction with the pageSize parameter. For example, \\'pageSize=1000&pageNum=2\\' returns records between 1001 and 2000.\", \"schema\": {\"default\": 1, \"type\": \"number\"}}, {\"name\": \"sort\", \"required\": false, \"in\": \"query\", \"description\": \"Sort the returned records. Sort is an array of multiple sort objects.The structure of a single sort object is `{\\\\\"order\\\\\":\\\\\"asc or desc\\\\\", \\\\\"field\\\\\":\\\\\"Field name or field ID\\\\\"}`.Query Example `sort[][field]=Customer Name&sort[][order]=asc`,The returned records are sorted alphabetically in the Customer Name column.If sort and viewId are used at the same time, the sort condition specified by sort will overwrite the sort condition in the view.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"object\"}}}, {\"name\": \"recordIds\", \"required\": false, \"in\": \"query\", \"example\": \"rec4zxfWB5uyM\", \"description\": \"Returns a specified record. Example of obtaining multiple records:`&recordIds=rec4zxfWB5uyM&,reclNflLgtzjY`. The returned results are sorted according to the order in which the recordIds are passed in. No paging, up to 1000 records can be returned each time.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all records and fields are returned.When the viewId is explicitly specified, all records in the specified view will be returned in turn according to the sorting in the specified view.Note that the hidden fields in the view will not appear in the returned results.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fields\", \"required\": false, \"in\": \"query\", \"description\": \"The returned record results are limited to the specified fields.cURL Query Example. 1. `&fields=name,age` (when `&fieldKey=name`) 2. `&fields=fldWooy3c3Puz,fldEAr5y7Go5S` (when `&fieldKey=id`).Both of the above two writing methods specify that the returned record only contains two columns \\\\u300cName\\\\u300d and \\\\u300cAge\\\\u300d.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"filterByFormula\", \"required\": false, \"in\": \"query\", \"description\": \"Use smart formulas to filter records.The formula can be used for reference[\\\\u300aFormula Overview\\\\u300b](https://help.aitable.ai/docs/guide/manual-formula-field-overview).If filterByFormula and viewId are used at the same time, all records in the specified view that meet this formula will be returned.Query Example. `&filterByFormula={Title}=\\\\\"tittle 1\\\\\"`(You need to use the encodeURIComponent() function to escape the \\'{Title}=\\\\\"Heading 1\\\\\"\\'.) You can accurately match the record with the value of \\\\\"Heading 1\\\\\" in the \\\\\"Heading\\\\\" column.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"cellFormat\", \"required\": false, \"in\": \"query\", \"description\": \"The type of the value in the cell. The default is `json`. When `string` is specified, all values will be automatically converted to string format.\\\\nWhen `string` is specified, if the returned records contain date-time values, these values will use the time zone given in the following order (priority from high to low):\\\\n1. If the date-time field has set a time zone, use that one.\\\\n2. If the user has set a time zone in user settings, use that one.\\\\n3. Use the default time zone (UTC-5, America/Toronto).\", \"schema\": {\"default\": \"json\", \"enum\": [\"string\", \"json\"], \"type\": \"string\"}}, {\"name\": \"fieldKey\", \"required\": false, \"in\": \"query\", \"description\": \"The key used when querying fields and returning fields. The default is\\' name \\'(field name). When \\'id\\' is specified, fieldId will be used as the query and return method (use \\'id\\' can avoid code invalidation caused by modifying field names).\", \"schema\": {\"default\": \"name\", \"enum\": [\"name\", \"id\"], \"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'GET', 'id': 'get-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"pageSize\", \"required\": false, \"in\": \"query\", \"example\": 100, \"description\": \"How many records are returned per page. By default, 100 records are returned per page. The value range is an integer from 1 to 1000.\", \"schema\": {\"default\": 100, \"type\": \"number\"}}, {\"name\": \"maxRecords\", \"required\": false, \"in\": \"query\", \"example\": 1000, \"description\": \"How many records are returned in total. If maxRecords and pageSize are used at the same time, and the value of maxRecords is less than the total number of records, only the setting of maxRecords will take effect.\", \"schema\": {\"type\": \"number\"}}, {\"name\": \"pageNum\", \"required\": false, \"in\": \"query\", \"example\": 1, \"description\": \"Specifies the page number of the page, which is used in conjunction with the pageSize parameter. For example, \\'pageSize=1000&pageNum=2\\' returns records between 1001 and 2000.\", \"schema\": {\"default\": 1, \"type\": \"number\"}}, {\"name\": \"sort\", \"required\": false, \"in\": \"query\", \"description\": \"Sort the returned records. Sort is an array of multiple sort objects.The structure of a single sort object is `{\\\\\"order\\\\\":\\\\\"asc or desc\\\\\", \\\\\"field\\\\\":\\\\\"Field name or field ID\\\\\"}`.Query Example `sort[][field]=Customer Name&sort[][order]=asc`,The returned records are sorted alphabetically in the Customer Name column.If sort and viewId are used at the same time, the sort condition specified by sort will overwrite the sort condition in the view.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"object\"}}}, {\"name\": \"recordIds\", \"required\": false, \"in\": \"query\", \"example\": \"rec4zxfWB5uyM\", \"description\": \"Returns a specified record. Example of obtaining multiple records:`&recordIds=rec4zxfWB5uyM&,reclNflLgtzjY`. The returned results are sorted according to the order in which the recordIds are passed in. No paging, up to 1000 records can be returned each time.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all records and fields are returned.When the viewId is explicitly specified, all records in the specified view will be returned in turn according to the sorting in the specified view.Note that the hidden fields in the view will not appear in the returned results.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fields\", \"required\": false, \"in\": \"query\", \"description\": \"The returned record results are limited to the specified fields.cURL Query Example. 1. `&fields=name,age` (when `&fieldKey=name`) 2. `&fields=fldWooy3c3Puz,fldEAr5y7Go5S` (when `&fieldKey=id`).Both of the above two writing methods specify that the returned record only contains two columns \\\\u300cName\\\\u300d and \\\\u300cAge\\\\u300d.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"filterByFormula\", \"required\": false, \"in\": \"query\", \"description\": \"Use smart formulas to filter records.The formula can be used for reference[\\\\u300aFormula Overview\\\\u300b](https://help.aitable.ai/docs/guide/manual-formula-field-overview).If filterByFormula and viewId are used at the same time, all records in the specified view that meet this formula will be returned.Query Example. `&filterByFormula={Title}=\\\\\"tittle 1\\\\\"`(You need to use the encodeURIComponent() function to escape the \\'{Title}=\\\\\"Heading 1\\\\\"\\'.) You can accurately match the record with the value of \\\\\"Heading 1\\\\\" in the \\\\\"Heading\\\\\" column.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"cellFormat\", \"required\": false, \"in\": \"query\", \"description\": \"The type of the value in the cell. The default is `json`. When `string` is specified, all values will be automatically converted to string format.\\\\nWhen `string` is specified, if the returned records contain date-time values, these values will use the time zone given in the following order (priority from high to low):\\\\n1. If the date-time field has set a time zone, use that one.\\\\n2. If the user has set a time zone in user settings, use that one.\\\\n3. Use the default time zone (UTC-5, America/Toronto).\", \"schema\": {\"default\": \"json\", \"enum\": [\"string\", \"json\"], \"type\": \"string\"}}, {\"name\": \"fieldKey\", \"required\": false, \"in\": \"query\", \"description\": \"The key used when querying fields and returning fields. The default is\\' name \\'(field name). When \\'id\\' is specified, fieldId will be used as the query and return method (use \\'id\\' can avoid code invalidation caused by modifying field names).\", \"schema\": {\"default\": \"name\", \"enum\": [\"name\", \"id\"], \"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'RecordPageVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/PageVo\"}]}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'RecordPageVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/PageVo\"}]}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'PATCH', 'id': 'update-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all fields that are not empty are returned; When the viewId is explicitly specified, the fields that are not hidden and are not empty in the specified view are returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'PATCH', 'id': 'update-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all fields that are not empty are returned; When the viewId is explicitly specified, the fields that are not hidden and are not empty in the specified view are returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'RecordListVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/ListVo\"}]}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'RecordListVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/ListVo\"}]}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'DELETE', 'id': 'delete-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"recordIds\", \"required\": true, \"in\": \"query\", \"description\": \"ID of the record to be deleted.\", \"example\": \"recwZ6yV3Srv3\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'DELETE', 'id': 'delete-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"recordIds\", \"required\": true, \"in\": \"query\", \"description\": \"ID of the record to be deleted.\", \"example\": \"recwZ6yV3Srv3\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'RecordDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"boolean\", \"description\": \"The returned business data body.\"}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'RecordDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"boolean\", \"description\": \"The returned business data body.\"}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/fields', 'method': 'GET', 'id': 'get-fields', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"View ID. If you specify a view, the returned fields are in the same order as the view. Hidden fields will not be returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/fields', 'method': 'GET', 'id': 'get-fields', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"View ID. If you specify a view, the returned fields are in the same order as the view. Hidden fields will not be returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'MetaFieldResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaFieldItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'MetaFieldResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaFieldItem\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields', 'method': 'POST', 'id': 'create-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields', 'method': 'POST', 'id': 'create-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'FieldCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"fldupsvkR2ATB\", \"description\": \"Field ID\"}, \"name\": {\"type\": \"string\", \"example\": \"Title\", \"description\": \"Field Name\"}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'FieldCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"fldupsvkR2ATB\", \"description\": \"Field ID\"}, \"name\": {\"type\": \"string\", \"example\": \"Title\", \"description\": \"Field Name\"}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields/{fieldId}', 'method': 'DELETE', 'id': 'delete-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fieldId\", \"required\": true, \"in\": \"path\", \"example\": \"fld7r18G7eSOu\", \"description\": \"field ID, field ID can be obtained through the field interface\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields/{fieldId}', 'method': 'DELETE', 'id': 'delete-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fieldId\", \"required\": true, \"in\": \"path\", \"example\": \"fld7r18G7eSOu\", \"description\": \"field ID, field ID can be obtained through the field interface\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'FieldDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\"}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'FieldDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\"}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/views', 'method': 'GET', 'id': 'get-views', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/views', 'method': 'GET', 'id': 'get-views', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'MetaViewResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"views\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaViewItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'MetaViewResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"views\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaViewItem\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/datasheets', 'method': 'POST', 'id': 'create-datasheets', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/datasheets', 'method': 'POST', 'id': 'create-datasheets', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'DatasheetCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"dstbs2U7mt8AEqgKuh\", \"description\": \"Form ID\"}, \"createdAt\": {\"type\": \"number\", \"example\": 1648648690000, \"description\": \"Create Timestamp\"}, \"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/FieldCreateItemVo\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'DatasheetCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"dstbs2U7mt8AEqgKuh\", \"description\": \"Form ID\"}, \"createdAt\": {\"type\": \"number\", \"example\": 1648648690000, \"description\": \"Create Timestamp\"}, \"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/FieldCreateItemVo\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces', 'method': 'GET', 'id': 'get-spaces', 'parameters': 'null'}, 'r': ({'path': '/fusion/v1/spaces', 'method': 'GET', 'id': 'get-spaces', 'parameters': 'null'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'SpaceListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"spaces\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/SpaceItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'SpaceListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"spaces\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/SpaceItem\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/nodes', 'method': 'GET', 'id': 'get-nodes', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spczdmQDfBAn5\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/nodes', 'method': 'GET', 'id': 'get-nodes', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spczdmQDfBAn5\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'NodeListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"nodes\": {\"type\": \"array\", \"description\": \"List of all files returned.\", \"items\": {\"$ref\": \"#/components/schemas/NodeItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'NodeListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"nodes\": {\"type\": \"array\", \"description\": \"List of all files returned.\", \"items\": {\"$ref\": \"#/components/schemas/NodeItem\"}}}}}'}}]\u001b[0m\n",
      "\n",
      "\u001b[1m> Finished chain.\u001b[0m\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "'您可以使用GET请求来获取表格中的记录。使用的API路径是/fusion/v1/datasheets/{datasheetId}/records，其中{datasheetId}是AITable数据表的ID。您可以通过提供的参数来指定返回的记录数量、排序方式、筛选条件等。默认情况下，每页返回100条记录。如果需要获取所有记录，可以使用maxRecords参数来指定返回的记录总数。'"
      ]
     },
     "execution_count": 20,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "cypher_chain.run(\"我怎么获取表格中的记录？\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 21,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "\n",
      "\u001b[1m> Entering new GraphCypherQAChain chain...\u001b[0m\n",
      "Generated Cypher:\n",
      "\u001b[32;1m\u001b[1;3mMATCH (e:Endpoint)-[r:RESPONSE_200]->(s:Schema) RETURN e, r, s LIMIT 10\u001b[0m\n",
      "Full Context:\n",
      "\u001b[32;1m\u001b[1;3m[{'e': {'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'GET', 'id': 'get-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"pageSize\", \"required\": false, \"in\": \"query\", \"example\": 100, \"description\": \"How many records are returned per page. By default, 100 records are returned per page. The value range is an integer from 1 to 1000.\", \"schema\": {\"default\": 100, \"type\": \"number\"}}, {\"name\": \"maxRecords\", \"required\": false, \"in\": \"query\", \"example\": 1000, \"description\": \"How many records are returned in total. If maxRecords and pageSize are used at the same time, and the value of maxRecords is less than the total number of records, only the setting of maxRecords will take effect.\", \"schema\": {\"type\": \"number\"}}, {\"name\": \"pageNum\", \"required\": false, \"in\": \"query\", \"example\": 1, \"description\": \"Specifies the page number of the page, which is used in conjunction with the pageSize parameter. For example, \\'pageSize=1000&pageNum=2\\' returns records between 1001 and 2000.\", \"schema\": {\"default\": 1, \"type\": \"number\"}}, {\"name\": \"sort\", \"required\": false, \"in\": \"query\", \"description\": \"Sort the returned records. Sort is an array of multiple sort objects.The structure of a single sort object is `{\\\\\"order\\\\\":\\\\\"asc or desc\\\\\", \\\\\"field\\\\\":\\\\\"Field name or field ID\\\\\"}`.Query Example `sort[][field]=Customer Name&sort[][order]=asc`,The returned records are sorted alphabetically in the Customer Name column.If sort and viewId are used at the same time, the sort condition specified by sort will overwrite the sort condition in the view.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"object\"}}}, {\"name\": \"recordIds\", \"required\": false, \"in\": \"query\", \"example\": \"rec4zxfWB5uyM\", \"description\": \"Returns a specified record. Example of obtaining multiple records:`&recordIds=rec4zxfWB5uyM&,reclNflLgtzjY`. The returned results are sorted according to the order in which the recordIds are passed in. No paging, up to 1000 records can be returned each time.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all records and fields are returned.When the viewId is explicitly specified, all records in the specified view will be returned in turn according to the sorting in the specified view.Note that the hidden fields in the view will not appear in the returned results.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fields\", \"required\": false, \"in\": \"query\", \"description\": \"The returned record results are limited to the specified fields.cURL Query Example. 1. `&fields=name,age` (when `&fieldKey=name`) 2. `&fields=fldWooy3c3Puz,fldEAr5y7Go5S` (when `&fieldKey=id`).Both of the above two writing methods specify that the returned record only contains two columns \\\\u300cName\\\\u300d and \\\\u300cAge\\\\u300d.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"filterByFormula\", \"required\": false, \"in\": \"query\", \"description\": \"Use smart formulas to filter records.The formula can be used for reference[\\\\u300aFormula Overview\\\\u300b](https://help.aitable.ai/docs/guide/manual-formula-field-overview).If filterByFormula and viewId are used at the same time, all records in the specified view that meet this formula will be returned.Query Example. `&filterByFormula={Title}=\\\\\"tittle 1\\\\\"`(You need to use the encodeURIComponent() function to escape the \\'{Title}=\\\\\"Heading 1\\\\\"\\'.) You can accurately match the record with the value of \\\\\"Heading 1\\\\\" in the \\\\\"Heading\\\\\" column.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"cellFormat\", \"required\": false, \"in\": \"query\", \"description\": \"The type of the value in the cell. The default is `json`. When `string` is specified, all values will be automatically converted to string format.\\\\nWhen `string` is specified, if the returned records contain date-time values, these values will use the time zone given in the following order (priority from high to low):\\\\n1. If the date-time field has set a time zone, use that one.\\\\n2. If the user has set a time zone in user settings, use that one.\\\\n3. Use the default time zone (UTC-5, America/Toronto).\", \"schema\": {\"default\": \"json\", \"enum\": [\"string\", \"json\"], \"type\": \"string\"}}, {\"name\": \"fieldKey\", \"required\": false, \"in\": \"query\", \"description\": \"The key used when querying fields and returning fields. The default is\\' name \\'(field name). When \\'id\\' is specified, fieldId will be used as the query and return method (use \\'id\\' can avoid code invalidation caused by modifying field names).\", \"schema\": {\"default\": \"name\", \"enum\": [\"name\", \"id\"], \"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'GET', 'id': 'get-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"pageSize\", \"required\": false, \"in\": \"query\", \"example\": 100, \"description\": \"How many records are returned per page. By default, 100 records are returned per page. The value range is an integer from 1 to 1000.\", \"schema\": {\"default\": 100, \"type\": \"number\"}}, {\"name\": \"maxRecords\", \"required\": false, \"in\": \"query\", \"example\": 1000, \"description\": \"How many records are returned in total. If maxRecords and pageSize are used at the same time, and the value of maxRecords is less than the total number of records, only the setting of maxRecords will take effect.\", \"schema\": {\"type\": \"number\"}}, {\"name\": \"pageNum\", \"required\": false, \"in\": \"query\", \"example\": 1, \"description\": \"Specifies the page number of the page, which is used in conjunction with the pageSize parameter. For example, \\'pageSize=1000&pageNum=2\\' returns records between 1001 and 2000.\", \"schema\": {\"default\": 1, \"type\": \"number\"}}, {\"name\": \"sort\", \"required\": false, \"in\": \"query\", \"description\": \"Sort the returned records. Sort is an array of multiple sort objects.The structure of a single sort object is `{\\\\\"order\\\\\":\\\\\"asc or desc\\\\\", \\\\\"field\\\\\":\\\\\"Field name or field ID\\\\\"}`.Query Example `sort[][field]=Customer Name&sort[][order]=asc`,The returned records are sorted alphabetically in the Customer Name column.If sort and viewId are used at the same time, the sort condition specified by sort will overwrite the sort condition in the view.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"object\"}}}, {\"name\": \"recordIds\", \"required\": false, \"in\": \"query\", \"example\": \"rec4zxfWB5uyM\", \"description\": \"Returns a specified record. Example of obtaining multiple records:`&recordIds=rec4zxfWB5uyM&,reclNflLgtzjY`. The returned results are sorted according to the order in which the recordIds are passed in. No paging, up to 1000 records can be returned each time.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all records and fields are returned.When the viewId is explicitly specified, all records in the specified view will be returned in turn according to the sorting in the specified view.Note that the hidden fields in the view will not appear in the returned results.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fields\", \"required\": false, \"in\": \"query\", \"description\": \"The returned record results are limited to the specified fields.cURL Query Example. 1. `&fields=name,age` (when `&fieldKey=name`) 2. `&fields=fldWooy3c3Puz,fldEAr5y7Go5S` (when `&fieldKey=id`).Both of the above two writing methods specify that the returned record only contains two columns \\\\u300cName\\\\u300d and \\\\u300cAge\\\\u300d.\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}, {\"name\": \"filterByFormula\", \"required\": false, \"in\": \"query\", \"description\": \"Use smart formulas to filter records.The formula can be used for reference[\\\\u300aFormula Overview\\\\u300b](https://help.aitable.ai/docs/guide/manual-formula-field-overview).If filterByFormula and viewId are used at the same time, all records in the specified view that meet this formula will be returned.Query Example. `&filterByFormula={Title}=\\\\\"tittle 1\\\\\"`(You need to use the encodeURIComponent() function to escape the \\'{Title}=\\\\\"Heading 1\\\\\"\\'.) You can accurately match the record with the value of \\\\\"Heading 1\\\\\" in the \\\\\"Heading\\\\\" column.\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"cellFormat\", \"required\": false, \"in\": \"query\", \"description\": \"The type of the value in the cell. The default is `json`. When `string` is specified, all values will be automatically converted to string format.\\\\nWhen `string` is specified, if the returned records contain date-time values, these values will use the time zone given in the following order (priority from high to low):\\\\n1. If the date-time field has set a time zone, use that one.\\\\n2. If the user has set a time zone in user settings, use that one.\\\\n3. Use the default time zone (UTC-5, America/Toronto).\", \"schema\": {\"default\": \"json\", \"enum\": [\"string\", \"json\"], \"type\": \"string\"}}, {\"name\": \"fieldKey\", \"required\": false, \"in\": \"query\", \"description\": \"The key used when querying fields and returning fields. The default is\\' name \\'(field name). When \\'id\\' is specified, fieldId will be used as the query and return method (use \\'id\\' can avoid code invalidation caused by modifying field names).\", \"schema\": {\"default\": \"name\", \"enum\": [\"name\", \"id\"], \"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'RecordPageVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/PageVo\"}]}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'RecordPageVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/PageVo\"}]}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'PATCH', 'id': 'update-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all fields that are not empty are returned; When the viewId is explicitly specified, the fields that are not hidden and are not empty in the specified view are returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'PATCH', 'id': 'update-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"When the viewId is not explicitly specified, all fields that are not empty are returned; When the viewId is explicitly specified, the fields that are not hidden and are not empty in the specified view are returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'RecordListVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/ListVo\"}]}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'RecordListVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"description\": \"The returned business data body.\", \"allOf\": [{\"$ref\": \"#/components/schemas/ListVo\"}]}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'DELETE', 'id': 'delete-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"recordIds\", \"required\": true, \"in\": \"query\", \"description\": \"ID of the record to be deleted.\", \"example\": \"recwZ6yV3Srv3\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/records', 'method': 'DELETE', 'id': 'delete-records', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"recordIds\", \"required\": true, \"in\": \"query\", \"description\": \"ID of the record to be deleted.\", \"example\": \"recwZ6yV3Srv3\", \"schema\": {\"type\": \"array\", \"items\": {\"type\": \"string\"}}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'RecordDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"boolean\", \"description\": \"The returned business data body.\"}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'RecordDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"boolean\", \"description\": \"The returned business data body.\"}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/fields', 'method': 'GET', 'id': 'get-fields', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"View ID. If you specify a view, the returned fields are in the same order as the view. Hidden fields will not be returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/fields', 'method': 'GET', 'id': 'get-fields', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"viewId\", \"required\": false, \"in\": \"query\", \"example\": \"viwG9l1VPD6nH\", \"description\": \"View ID. If you specify a view, the returned fields are in the same order as the view. Hidden fields will not be returned.\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'MetaFieldResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaFieldItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'MetaFieldResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaFieldItem\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields', 'method': 'POST', 'id': 'create-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields', 'method': 'POST', 'id': 'create-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'FieldCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"fldupsvkR2ATB\", \"description\": \"Field ID\"}, \"name\": {\"type\": \"string\", \"example\": \"Title\", \"description\": \"Field Name\"}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'FieldCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"fldupsvkR2ATB\", \"description\": \"Field ID\"}, \"name\": {\"type\": \"string\", \"example\": \"Title\", \"description\": \"Field Name\"}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields/{fieldId}', 'method': 'DELETE', 'id': 'delete-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fieldId\", \"required\": true, \"in\": \"path\", \"example\": \"fld7r18G7eSOu\", \"description\": \"field ID, field ID can be obtained through the field interface\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/datasheets/{datasheetId}/fields/{fieldId}', 'method': 'DELETE', 'id': 'delete-fields', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dstNiC6R9MryevVaCQ\", \"description\": \"Datasheet ID\", \"schema\": {\"type\": \"string\"}}, {\"name\": \"fieldId\", \"required\": true, \"in\": \"path\", \"example\": \"fld7r18G7eSOu\", \"description\": \"field ID, field ID can be obtained through the field interface\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'FieldDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\"}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'FieldDeleteVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\"}}'}}, {'e': {'path': '/fusion/v1/datasheets/{datasheetId}/views', 'method': 'GET', 'id': 'get-views', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/datasheets/{datasheetId}/views', 'method': 'GET', 'id': 'get-views', 'parameters': '[{\"name\": \"datasheetId\", \"required\": true, \"in\": \"path\", \"example\": \"dst0Yj5aNeoHldqvf6\", \"description\": \"AITable Datasheet ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'MetaViewResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"views\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaViewItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'MetaViewResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"views\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/MetaViewItem\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/datasheets', 'method': 'POST', 'id': 'create-datasheets', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/datasheets', 'method': 'POST', 'id': 'create-datasheets', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spcjXzqVrjaP3\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'DatasheetCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"dstbs2U7mt8AEqgKuh\", \"description\": \"Form ID\"}, \"createdAt\": {\"type\": \"number\", \"example\": 1648648690000, \"description\": \"Create Timestamp\"}, \"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/FieldCreateItemVo\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'DatasheetCreateVo', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"properties\": {\"id\": {\"type\": \"string\", \"example\": \"dstbs2U7mt8AEqgKuh\", \"description\": \"Form ID\"}, \"createdAt\": {\"type\": \"number\", \"example\": 1648648690000, \"description\": \"Create Timestamp\"}, \"fields\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/FieldCreateItemVo\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces', 'method': 'GET', 'id': 'get-spaces', 'parameters': 'null'}, 'r': ({'path': '/fusion/v1/spaces', 'method': 'GET', 'id': 'get-spaces', 'parameters': 'null'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'SpaceListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"spaces\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/SpaceItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'SpaceListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"spaces\": {\"type\": \"array\", \"items\": {\"$ref\": \"#/components/schemas/SpaceItem\"}}}}}'}}, {'e': {'path': '/fusion/v1/spaces/{spaceId}/nodes', 'method': 'GET', 'id': 'get-nodes', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spczdmQDfBAn5\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'r': ({'path': '/fusion/v1/spaces/{spaceId}/nodes', 'method': 'GET', 'id': 'get-nodes', 'parameters': '[{\"name\": \"spaceId\", \"required\": true, \"in\": \"path\", \"example\": \"spczdmQDfBAn5\", \"description\": \"Space ID\", \"schema\": {\"type\": \"string\"}}]'}, 'RESPONSE_200', {'allOf': '[]', 'description': '', 'id': 'NodeListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"nodes\": {\"type\": \"array\", \"description\": \"List of all files returned.\", \"items\": {\"$ref\": \"#/components/schemas/NodeItem\"}}}}}'}), 's': {'allOf': '[]', 'description': '', 'id': 'NodeListResp', 'properties': '{\"success\": {\"type\": \"boolean\", \"example\": true, \"description\": \"The global status value. If it is false, it indicates that a business error or interface call error has occurred.\"}, \"code\": {\"type\": \"number\", \"example\": 200, \"description\": \"Business status code, 200 indicates that the business request is successful.\"}, \"message\": {\"type\": \"string\", \"example\": \"SUCCESS\", \"description\": \"Return information, and return error information when executing an error.\"}, \"data\": {\"type\": \"object\", \"description\": \"The returned business data body.\", \"properties\": {\"nodes\": {\"type\": \"array\", \"description\": \"List of all files returned.\", \"items\": {\"$ref\": \"#/components/schemas/NodeItem\"}}}}}'}}]\u001b[0m\n",
      "\n",
      "\u001b[1m> Finished chain.\u001b[0m\n"
     ]
    },
    {
     "data": {
      "text/plain": [
       "'您可以使用`filterByFormula`参数来筛选记录。该参数使用智能公式来过滤记录。您可以参考[公式概述](https://help.aitable.ai/docs/guide/manual-formula-field-overview)来使用公式进行筛选。例如，您可以使用`filterByFormula={Title}=\"tittle 1\"`来筛选出标题为\"tittle 1\"的记录。请注意，您需要使用`encodeURIComponent()`函数来转义公式中的特殊字符。'"
      ]
     },
     "execution_count": 21,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "cypher_chain.run(\"我想要获取筛选后的记录，该怎么办？\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 23,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "\n",
      "\u001b[1m> Entering new GraphCypherQAChain chain...\u001b[0m\n",
      "Generated Cypher:\n",
      "\u001b[32;1m\u001b[1;3mSorry, but I can't assist with that.\u001b[0m\n"
     ]
    },
    {
     "ename": "ValueError",
     "evalue": "Generated Cypher Statement is not valid\n{code: Neo.ClientError.Statement.SyntaxError} {message: Invalid input 'Sorry': expected\n  \"ALTER\"\n  \"CALL\"\n  \"CREATE\"\n  \"DEALLOCATE\"\n  \"DELETE\"\n  \"DENY\"\n  \"DETACH\"\n  \"DROP\"\n  \"DRYRUN\"\n  \"ENABLE\"\n  \"FOREACH\"\n  \"GRANT\"\n  \"LOAD\"\n  \"MATCH\"\n  \"MERGE\"\n  \"OPTIONAL\"\n  \"REALLOCATE\"\n  \"REMOVE\"\n  \"RENAME\"\n  \"RETURN\"\n  \"REVOKE\"\n  \"SET\"\n  \"SHOW\"\n  \"START\"\n  \"STOP\"\n  \"TERMINATE\"\n  \"UNWIND\"\n  \"USE\"\n  \"USING\"\n  \"WITH\" (line 1, column 1 (offset: 0))\n\"Sorry, but I can't assist with that.\"\n ^}",
     "output_type": "error",
     "traceback": [
      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
      "\u001b[0;31mCypherSyntaxError\u001b[0m                         Traceback (most recent call last)",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/langchain/graphs/neo4j_graph.py:79\u001b[0m, in \u001b[0;36mNeo4jGraph.query\u001b[0;34m(self, query, params)\u001b[0m\n\u001b[1;32m     78\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m---> 79\u001b[0m     data \u001b[39m=\u001b[39m session\u001b[39m.\u001b[39;49mrun(query, params)\n\u001b[1;32m     80\u001b[0m     \u001b[39mreturn\u001b[39;00m [r\u001b[39m.\u001b[39mdata() \u001b[39mfor\u001b[39;00m r \u001b[39min\u001b[39;00m data]\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/work/session.py:314\u001b[0m, in \u001b[0;36mSession.run\u001b[0;34m(self, query, parameters, **kwargs)\u001b[0m\n\u001b[1;32m    313\u001b[0m parameters \u001b[39m=\u001b[39m \u001b[39mdict\u001b[39m(parameters \u001b[39mor\u001b[39;00m {}, \u001b[39m*\u001b[39m\u001b[39m*\u001b[39mkwargs)\n\u001b[0;32m--> 314\u001b[0m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_auto_result\u001b[39m.\u001b[39;49m_run(\n\u001b[1;32m    315\u001b[0m     query, parameters, \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_config\u001b[39m.\u001b[39;49mdatabase,\n\u001b[1;32m    316\u001b[0m     \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_config\u001b[39m.\u001b[39;49mimpersonated_user, \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_config\u001b[39m.\u001b[39;49mdefault_access_mode,\n\u001b[1;32m    317\u001b[0m     bookmarks, \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_config\u001b[39m.\u001b[39;49mnotifications_min_severity,\n\u001b[1;32m    318\u001b[0m     \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_config\u001b[39m.\u001b[39;49mnotifications_disabled_categories,\n\u001b[1;32m    319\u001b[0m )\n\u001b[1;32m    321\u001b[0m \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_auto_result\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/work/result.py:166\u001b[0m, in \u001b[0;36mResult._run\u001b[0;34m(self, query, parameters, db, imp_user, access_mode, bookmarks, notifications_min_severity, notifications_disabled_categories)\u001b[0m\n\u001b[1;32m    165\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_connection\u001b[39m.\u001b[39msend_all()\n\u001b[0;32m--> 166\u001b[0m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_attach()\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/work/result.py:274\u001b[0m, in \u001b[0;36mResult._attach\u001b[0;34m(self)\u001b[0m\n\u001b[1;32m    273\u001b[0m \u001b[39mwhile\u001b[39;00m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_attached \u001b[39mis\u001b[39;00m \u001b[39mFalse\u001b[39;00m:\n\u001b[0;32m--> 274\u001b[0m     \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_connection\u001b[39m.\u001b[39;49mfetch_message()\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/io/_common.py:180\u001b[0m, in \u001b[0;36mConnectionErrorHandler.__getattr__.<locals>.outer.<locals>.inner\u001b[0;34m(*args, **kwargs)\u001b[0m\n\u001b[1;32m    179\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m--> 180\u001b[0m     func(\u001b[39m*\u001b[39;49margs, \u001b[39m*\u001b[39;49m\u001b[39m*\u001b[39;49mkwargs)\n\u001b[1;32m    181\u001b[0m \u001b[39mexcept\u001b[39;00m (Neo4jError, ServiceUnavailable, SessionExpired) \u001b[39mas\u001b[39;00m exc:\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/io/_bolt.py:851\u001b[0m, in \u001b[0;36mBolt.fetch_message\u001b[0;34m(self)\u001b[0m\n\u001b[1;32m    848\u001b[0m tag, fields \u001b[39m=\u001b[39m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39minbox\u001b[39m.\u001b[39mpop(\n\u001b[1;32m    849\u001b[0m     hydration_hooks\u001b[39m=\u001b[39m\u001b[39mself\u001b[39m\u001b[39m.\u001b[39mresponses[\u001b[39m0\u001b[39m]\u001b[39m.\u001b[39mhydration_hooks\n\u001b[1;32m    850\u001b[0m )\n\u001b[0;32m--> 851\u001b[0m res \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_process_message(tag, fields)\n\u001b[1;32m    852\u001b[0m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39midle_since \u001b[39m=\u001b[39m perf_counter()\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/io/_bolt5.py:376\u001b[0m, in \u001b[0;36mBolt5x0._process_message\u001b[0;34m(self, tag, fields)\u001b[0m\n\u001b[1;32m    375\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[0;32m--> 376\u001b[0m     response\u001b[39m.\u001b[39;49mon_failure(summary_metadata \u001b[39mor\u001b[39;49;00m {})\n\u001b[1;32m    377\u001b[0m \u001b[39mexcept\u001b[39;00m (ServiceUnavailable, DatabaseUnavailable):\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/neo4j/_sync/io/_common.py:247\u001b[0m, in \u001b[0;36mResponse.on_failure\u001b[0;34m(self, metadata)\u001b[0m\n\u001b[1;32m    246\u001b[0m Util\u001b[39m.\u001b[39mcallback(handler)\n\u001b[0;32m--> 247\u001b[0m \u001b[39mraise\u001b[39;00m Neo4jError\u001b[39m.\u001b[39mhydrate(\u001b[39m*\u001b[39m\u001b[39m*\u001b[39mmetadata)\n",
      "\u001b[0;31mCypherSyntaxError\u001b[0m: {code: Neo.ClientError.Statement.SyntaxError} {message: Invalid input 'Sorry': expected\n  \"ALTER\"\n  \"CALL\"\n  \"CREATE\"\n  \"DEALLOCATE\"\n  \"DELETE\"\n  \"DENY\"\n  \"DETACH\"\n  \"DROP\"\n  \"DRYRUN\"\n  \"ENABLE\"\n  \"FOREACH\"\n  \"GRANT\"\n  \"LOAD\"\n  \"MATCH\"\n  \"MERGE\"\n  \"OPTIONAL\"\n  \"REALLOCATE\"\n  \"REMOVE\"\n  \"RENAME\"\n  \"RETURN\"\n  \"REVOKE\"\n  \"SET\"\n  \"SHOW\"\n  \"START\"\n  \"STOP\"\n  \"TERMINATE\"\n  \"UNWIND\"\n  \"USE\"\n  \"USING\"\n  \"WITH\" (line 1, column 1 (offset: 0))\n\"Sorry, but I can't assist with that.\"\n ^}",
      "\nDuring handling of the above exception, another exception occurred:\n",
      "\u001b[0;31mValueError\u001b[0m                                Traceback (most recent call last)",
      "\u001b[1;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/apitable_devbook_knowledge_graph.ipynb 单元格 9\u001b[0m line \u001b[0;36m1\n\u001b[0;32m----> <a href='vscode-notebook-cell://ssh-remote%2Bdebian.xukecheng.tech/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/apitable_devbook_knowledge_graph.ipynb#X21sdnNjb2RlLXJlbW90ZQ%3D%3D?line=0'>1</a>\u001b[0m cypher_chain\u001b[39m.\u001b[39;49mrun(\u001b[39m\"\u001b[39;49m\u001b[39m报错了，401，咋办\u001b[39;49m\u001b[39m\"\u001b[39;49m)\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/langchain/chains/base.py:503\u001b[0m, in \u001b[0;36mChain.run\u001b[0;34m(self, callbacks, tags, metadata, *args, **kwargs)\u001b[0m\n\u001b[1;32m    501\u001b[0m     \u001b[39mif\u001b[39;00m \u001b[39mlen\u001b[39m(args) \u001b[39m!=\u001b[39m \u001b[39m1\u001b[39m:\n\u001b[1;32m    502\u001b[0m         \u001b[39mraise\u001b[39;00m \u001b[39mValueError\u001b[39;00m(\u001b[39m\"\u001b[39m\u001b[39m`run` supports only one positional argument.\u001b[39m\u001b[39m\"\u001b[39m)\n\u001b[0;32m--> 503\u001b[0m     \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39;49m(args[\u001b[39m0\u001b[39;49m], callbacks\u001b[39m=\u001b[39;49mcallbacks, tags\u001b[39m=\u001b[39;49mtags, metadata\u001b[39m=\u001b[39;49mmetadata)[\n\u001b[1;32m    504\u001b[0m         _output_key\n\u001b[1;32m    505\u001b[0m     ]\n\u001b[1;32m    507\u001b[0m \u001b[39mif\u001b[39;00m kwargs \u001b[39mand\u001b[39;00m \u001b[39mnot\u001b[39;00m args:\n\u001b[1;32m    508\u001b[0m     \u001b[39mreturn\u001b[39;00m \u001b[39mself\u001b[39m(kwargs, callbacks\u001b[39m=\u001b[39mcallbacks, tags\u001b[39m=\u001b[39mtags, metadata\u001b[39m=\u001b[39mmetadata)[\n\u001b[1;32m    509\u001b[0m         _output_key\n\u001b[1;32m    510\u001b[0m     ]\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/langchain/chains/base.py:308\u001b[0m, in \u001b[0;36mChain.__call__\u001b[0;34m(self, inputs, return_only_outputs, callbacks, tags, metadata, run_name, include_run_info)\u001b[0m\n\u001b[1;32m    306\u001b[0m \u001b[39mexcept\u001b[39;00m \u001b[39mBaseException\u001b[39;00m \u001b[39mas\u001b[39;00m e:\n\u001b[1;32m    307\u001b[0m     run_manager\u001b[39m.\u001b[39mon_chain_error(e)\n\u001b[0;32m--> 308\u001b[0m     \u001b[39mraise\u001b[39;00m e\n\u001b[1;32m    309\u001b[0m run_manager\u001b[39m.\u001b[39mon_chain_end(outputs)\n\u001b[1;32m    310\u001b[0m final_outputs: Dict[\u001b[39mstr\u001b[39m, Any] \u001b[39m=\u001b[39m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39mprep_outputs(\n\u001b[1;32m    311\u001b[0m     inputs, outputs, return_only_outputs\n\u001b[1;32m    312\u001b[0m )\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/langchain/chains/base.py:302\u001b[0m, in \u001b[0;36mChain.__call__\u001b[0;34m(self, inputs, return_only_outputs, callbacks, tags, metadata, run_name, include_run_info)\u001b[0m\n\u001b[1;32m    295\u001b[0m run_manager \u001b[39m=\u001b[39m callback_manager\u001b[39m.\u001b[39mon_chain_start(\n\u001b[1;32m    296\u001b[0m     dumpd(\u001b[39mself\u001b[39m),\n\u001b[1;32m    297\u001b[0m     inputs,\n\u001b[1;32m    298\u001b[0m     name\u001b[39m=\u001b[39mrun_name,\n\u001b[1;32m    299\u001b[0m )\n\u001b[1;32m    300\u001b[0m \u001b[39mtry\u001b[39;00m:\n\u001b[1;32m    301\u001b[0m     outputs \u001b[39m=\u001b[39m (\n\u001b[0;32m--> 302\u001b[0m         \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49m_call(inputs, run_manager\u001b[39m=\u001b[39;49mrun_manager)\n\u001b[1;32m    303\u001b[0m         \u001b[39mif\u001b[39;00m new_arg_supported\n\u001b[1;32m    304\u001b[0m         \u001b[39melse\u001b[39;00m \u001b[39mself\u001b[39m\u001b[39m.\u001b[39m_call(inputs)\n\u001b[1;32m    305\u001b[0m     )\n\u001b[1;32m    306\u001b[0m \u001b[39mexcept\u001b[39;00m \u001b[39mBaseException\u001b[39;00m \u001b[39mas\u001b[39;00m e:\n\u001b[1;32m    307\u001b[0m     run_manager\u001b[39m.\u001b[39mon_chain_error(e)\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/langchain/chains/graph_qa/cypher.py:206\u001b[0m, in \u001b[0;36mGraphCypherQAChain._call\u001b[0;34m(self, inputs, run_manager)\u001b[0m\n\u001b[1;32m    203\u001b[0m \u001b[39m# Retrieve and limit the number of results\u001b[39;00m\n\u001b[1;32m    204\u001b[0m \u001b[39m# Generated Cypher be null if query corrector identifies invalid schema\u001b[39;00m\n\u001b[1;32m    205\u001b[0m \u001b[39mif\u001b[39;00m generated_cypher:\n\u001b[0;32m--> 206\u001b[0m     context \u001b[39m=\u001b[39m \u001b[39mself\u001b[39;49m\u001b[39m.\u001b[39;49mgraph\u001b[39m.\u001b[39;49mquery(generated_cypher)[: \u001b[39mself\u001b[39m\u001b[39m.\u001b[39mtop_k]\n\u001b[1;32m    207\u001b[0m \u001b[39melse\u001b[39;00m:\n\u001b[1;32m    208\u001b[0m     context \u001b[39m=\u001b[39m []\n",
      "File \u001b[0;32m/projects/xukecheng/APITable-LLMs-Enhancement-Experiments/.venv/lib/python3.11/site-packages/langchain/graphs/neo4j_graph.py:82\u001b[0m, in \u001b[0;36mNeo4jGraph.query\u001b[0;34m(self, query, params)\u001b[0m\n\u001b[1;32m     80\u001b[0m     \u001b[39mreturn\u001b[39;00m [r\u001b[39m.\u001b[39mdata() \u001b[39mfor\u001b[39;00m r \u001b[39min\u001b[39;00m data]\n\u001b[1;32m     81\u001b[0m \u001b[39mexcept\u001b[39;00m CypherSyntaxError \u001b[39mas\u001b[39;00m e:\n\u001b[0;32m---> 82\u001b[0m     \u001b[39mraise\u001b[39;00m \u001b[39mValueError\u001b[39;00m(\u001b[39mf\u001b[39m\u001b[39m\"\u001b[39m\u001b[39mGenerated Cypher Statement is not valid\u001b[39m\u001b[39m\\n\u001b[39;00m\u001b[39m{\u001b[39;00me\u001b[39m}\u001b[39;00m\u001b[39m\"\u001b[39m)\n",
      "\u001b[0;31mValueError\u001b[0m: Generated Cypher Statement is not valid\n{code: Neo.ClientError.Statement.SyntaxError} {message: Invalid input 'Sorry': expected\n  \"ALTER\"\n  \"CALL\"\n  \"CREATE\"\n  \"DEALLOCATE\"\n  \"DELETE\"\n  \"DENY\"\n  \"DETACH\"\n  \"DROP\"\n  \"DRYRUN\"\n  \"ENABLE\"\n  \"FOREACH\"\n  \"GRANT\"\n  \"LOAD\"\n  \"MATCH\"\n  \"MERGE\"\n  \"OPTIONAL\"\n  \"REALLOCATE\"\n  \"REMOVE\"\n  \"RENAME\"\n  \"RETURN\"\n  \"REVOKE\"\n  \"SET\"\n  \"SHOW\"\n  \"START\"\n  \"STOP\"\n  \"TERMINATE\"\n  \"UNWIND\"\n  \"USE\"\n  \"USING\"\n  \"WITH\" (line 1, column 1 (offset: 0))\n\"Sorry, but I can't assist with that.\"\n ^}"
     ]
    }
   ],
   "source": [
    "cypher_chain.run(\"报错了，401，咋办\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": ".venv",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}