Added Persian/Farsi Translations

fa/.gitbook/assets/Dify-test.openapi.json

@@ -0,0 +1,192 @@
+{
+  "openapi": "3.0.1",
+  "info": { "title": "Dify-test", "description": "", "version": "1.0.0" },
+  "tags": [],
+  "paths": {
+    "/retrieval": {
+      "post": {
+        "summary": "Knowledge Retrieval API",
+        "deprecated": false,
+        "description": "This API is used to connect to a knowledge base that is independent of the Dify and maintained by developers. For more details, please refer to [Connecting to an External Knowledge Base](https://docs.dify.ai/guides/knowledge-base/connect-external-knowledge-base). You can use API-Key in the Authorization HTTP Header to verify permissions, the authentication logic is defined by you in the retrieval API, as shown below:\n\n```text\nAuthorization: Bearer {API_KEY}\n```",
+        "tags": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "knowledge_id": {
+                    "type": "string",
+                    "description": "Your knowledge's unique ID"
+                  },
+                  "query": { "type": "string", "description": "User's query" },
+                  "retrival_setting": {
+                    "type": "object",
+                    "properties": {
+                      "top_k": {
+                        "type": "integer",
+                        "description": "Maximum number of retrieved results"
+                      },
+                      "score_threshold": {
+                        "type": "number",
+                        "description": "The score limit of relevance of the result to the query, scope: 0~1",
+                        "format": "float",
+                        "minimum": 0,
+                        "maximum": 1
+                      }
+                    },
+                    "description": "Knowledge's retrieval parameters ",
+                    "required": ["top_k", "score_threshold"]
+                  }
+                },
+                "required": ["knowledge_id", "query", "retrival_setting"]
+              },
+              "example": {
+                "knowledge_id": "your-knowledge-id",
+                "query": "your question",
+                "retrival_setting": { "top_k": 2, "score_threshold": 0.5 }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "If the action is successful, the service sends back an HTTP 200 response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "records": {
+                      "type": "object",
+                      "properties": {
+                        "content": {
+                          "type": "string",
+                          "description": "Contains a chunk of text from a data source in the knowledge base."
+                        },
+                        "score": {
+                          "type": "number",
+                          "format": "float",
+                          "description": "The score of relevance of the result to the query, scope: 0~1"
+                        },
+                        "title": {
+                          "type": "string",
+                          "description": "Document title"
+                        },
+                        "metadata": {
+                          "type": "string",
+                          "description": "Contains metadata attributes and their values for the document in the data source."
+                        }
+                      },
+                      "title": "A list of records from querying the knowledge base.",
+                      "required": ["content", "score", "title"]
+                    }
+                  },
+                  "required": ["records"]
+                },
+                "examples": {
+                  "1": {
+                    "summary": "Success",
+                    "value": {
+                      "records": [
+                        {
+                          "metadata": {
+                            "path": "s3://dify/knowledge.txt",
+                            "description": "dify knowledge document"
+                          },
+                          "score": 0.98,
+                          "title": "knowledge.txt",
+                          "content": "This is the document for external knowledge."
+                        },
+                        {
+                          "metadata": {
+                            "path": "s3://dify/introduce.txt",
+                            "description": "dify introduce"
+                          },
+                          "score": 0.66,
+                          "title": "introduce.txt",
+                          "content": "The Innovation Engine for GenAI Applications"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            },
+            "headers": {}
+          },
+          "403": {
+            "description": "The request is denied because of missing access permissions. Check your permissions and retry your request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "",
+                  "type": "object",
+                  "properties": {
+                    "error_code": {
+                      "type": "integer",
+                      "description": "error code"
+                    },
+                    "error_msg": {
+                      "type": "string",
+                      "description": "The description of api exception"
+                    }
+                  },
+                  "required": ["error_code", "error_msg"]
+                },
+                "examples": {
+                  "1": {
+                    "summary": "Erros",
+                    "value": {
+                      "error_code": 1001,
+                      "error_msg": "Invalid Authorization header format. Expected 'Bearer <api-key>' format."
+                    }
+                  }
+                }
+              }
+            },
+            "headers": {}
+          },
+          "500": {
+            "description": "An internal server error occurred. Retry your request.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "",
+                  "type": "object",
+                  "properties": {
+                    "error_code": {
+                      "type": "integer",
+                      "description": "error code"
+                    },
+                    "error_msg": {
+                      "type": "string",
+                      "description": "The description of api exception"
+                    }
+                  },
+                  "required": ["error_code", "error_msg"]
+                },
+                "examples": {
+                  "1": {
+                    "summary": "Erros",
+                    "value": {
+                      "error_code": 1001,
+                      "error_msg": "Invalid Authorization header format. Expected 'Bearer <api-key>' format."
+                    }
+                  }
+                }
+              }
+            },
+            "headers": {}
+          }
+        },
+        "security": [{ "bearer": [] }]
+      }
+    }
+  },
+  "components": {
+    "schemas": {},
+    "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" } }
+  },
+  "servers": [{ "url": "your-endpoint", "description": "测试环境" }]
+}