agent-generator 1.0.3 → 1.0.5

package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json

@@ -1,756 +0,0 @@
-{
-  "openapi" : "3.1.0",
-  "info" : {
-    "title" : "ZIAAnswerbotInference",
-    "version" : "1.0.0",
-    "x-clan-group" : "zia",
-    "x-module-group" : "zia"
-  },
-  "paths" : {
-    "/api/v1/public/answerbot/session/end" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "summary" : "",
-        "description" : "",
-        "operationId" : "endPublicSession",
-        "parameters" : [ {
-          "$ref" : "#/components/parameters/botId"
-        }, {
-          "$ref" : "#/components/parameters/sessionId"
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/endSession"
-          }
-        },
-        "x-audience" : [ "company-internal" ]
-      }
-    },
-    "/api/v1/answerbot/query" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "operationId" : "getChatQuery",
-        "parameters" : [ {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "requestBody" : {
-          "$ref" : "#/components/requestBodies/answerbotQuery"
-        },
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          }
-        },
-        "security" : [ {
-          "org-oauth" : [ "Desk.accessAll.ALL" ]
-        }, {
-          "iam-oauth2-schema" : [ "Desk.zia.READ" ]
-        } ],
-        "x-audience" : [ "company-internal" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 60,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 600000,
-                  "threshold" : 500,
-                  "hip" : false
-                }, {
-                  "duration" : 86400000,
-                  "lock-period" : 1800000,
-                  "threshold" : 5000,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.zuid"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "clan-group" : "zia",
-          "module-group" : "zia",
-          "apimethod" : "com.zoho.desk.bot.zia.services.AnswerBotService.getChatQuery"
-        }
-      }
-    },
-    "/api/v1/public/answerbot/chat" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "operationId" : "getPublicChatAnswer",
-        "parameters" : [ {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "requestBody" : {
-          "$ref" : "#/components/requestBodies/answerbotPublicChat"
-        },
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          }
-        },
-        "security" : [ { } ],
-        "x-audience" : [ "company-internal" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 60,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 600000,
-                  "threshold" : 500,
-                  "hip" : false
-                }, {
-                  "duration" : 86400000,
-                  "lock-period" : 1800000,
-                  "threshold" : 5000,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.remoteip"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "clan-group" : "zia",
-          "module-group" : "zia",
-          "apimethod" : "com.zoho.desk.bot.zia.services.AnswerBotService.getPublicChatAnswer"
-        }
-      }
-    },
-    "/api/v1/answerbot/chat" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "operationId" : "getChatAnswer",
-        "parameters" : [ {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "requestBody" : {
-          "$ref" : "#/components/requestBodies/answerbotChat"
-        },
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          }
-        },
-        "security" : [ {
-          "org-oauth" : [ "Desk.accessAll.ALL" ]
-        }, {
-          "iam-oauth2-schema" : [ "Desk.zia.READ" ]
-        } ],
-        "x-audience" : [ "company-internal" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 60,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 600000,
-                  "threshold" : 500,
-                  "hip" : false
-                }, {
-                  "duration" : 86400000,
-                  "lock-period" : 1800000,
-                  "threshold" : 5000,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.zuid"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "clan-group" : "zia",
-          "module-group" : "zia",
-          "apimethod" : "com.zoho.desk.bot.zia.services.AnswerBotService.getChatAnswer"
-        }
-      }
-    },
-    "/api/v1/answerbot/session/end" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "summary" : "",
-        "description" : "",
-        "operationId" : "endSession",
-        "parameters" : [ {
-          "$ref" : "#/components/parameters/botId"
-        }, {
-          "$ref" : "#/components/parameters/sessionId"
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/endSession"
-          }
-        },
-        "x-audience" : [ "company-internal" ]
-      }
-    },
-    "/api/v1/public/answerbot/query" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "operationId" : "getPublicChatQuery",
-        "parameters" : [ {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "requestBody" : {
-          "$ref" : "#/components/requestBodies/answerbotPublicQuery"
-        },
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          }
-        },
-        "security" : [ { } ],
-        "x-audience" : [ "company-internal" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 60,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 600000,
-                  "threshold" : 500,
-                  "hip" : false
-                }, {
-                  "duration" : 86400000,
-                  "lock-period" : 1800000,
-                  "threshold" : 5000,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.remoteip"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "clan-group" : "zia",
-          "module-group" : "zia",
-          "apimethod" : "com.zoho.desk.bot.zia.services.AnswerBotService.getPublicChatQuery"
-        }
-      }
-    },
-    "/api/v1/answerbot/session/start" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "operationId" : "startSession",
-        "parameters" : [ {
-          "$ref" : "#/components/parameters/botId"
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/startSession"
-          }
-        },
-        "security" : [ {
-          "org-oauth" : [ "Desk.accessAll.ALL" ]
-        }, {
-          "iam-oauth2-schema" : [ "Desk.zia.READ" ]
-        } ],
-        "x-audience" : [ "company-internal" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 60,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 600000,
-                  "threshold" : 500,
-                  "hip" : false
-                }, {
-                  "duration" : 86400000,
-                  "lock-period" : 1800000,
-                  "threshold" : 5000,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.zuid"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "clan-group" : "zia",
-          "module-group" : "zia",
-          "apimethod" : "com.zoho.desk.bot.zia.services.AnswerBotService.startSession"
-        }
-      }
-    },
-    "/api/v1/public/answerbot/session/start" : {
-      "post" : {
-        "tags" : [ "ZIAAnswerbotInference" ],
-        "operationId" : "startPublicSession",
-        "parameters" : [ {
-          "$ref" : "#/components/parameters/botId"
-        }, {
-          "$ref" : "../common/Common.json#/components/parameters/orgId"
-        } ],
-        "responses" : {
-          "204" : {
-            "$ref" : "../common/Common.json#/components/responses/emptyResponse"
-          },
-          "200" : {
-            "$ref" : "#/components/responses/startSession"
-          }
-        },
-        "security" : [ { } ],
-        "x-audience" : [ "company-internal" ],
-        "x-custom-url-attribute" : {
-          "security" : {
-            "throttle" : {
-              "inline" : [ {
-                "scope" : "APPSERVER",
-                "rules" : [ {
-                  "duration" : 60000,
-                  "lock-period" : 300000,
-                  "threshold" : 60,
-                  "hip" : false
-                }, {
-                  "duration" : 3600000,
-                  "lock-period" : 600000,
-                  "threshold" : 500,
-                  "hip" : false
-                }, {
-                  "duration" : 86400000,
-                  "lock-period" : 1800000,
-                  "threshold" : 5000,
-                  "hip" : false
-                } ],
-                "window" : "ROLLING",
-                "key" : "url.path+user.remoteip"
-              } ]
-            },
-            "extraparams" : {
-              "disable" : true,
-              "ignore" : false
-            },
-            "authentication" : { }
-          },
-          "clan-group" : "zia",
-          "module-group" : "zia",
-          "apimethod" : "com.zoho.desk.bot.zia.services.AnswerBotService.startPublicSession"
-        }
-      }
-    }
-  },
-  "components" : {
-    "schemas" : {
-      "thresholdConfiguration" : {
-        "type" : [ "null", "object" ],
-        "additionalProperties" : false,
-        "properties" : {
-          "passage" : {
-            "type" : [ "string", "null" ],
-            "description" : "paragraph threshold",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
-          },
-          "common" : {
-            "type" : [ "string", "null" ],
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
-          },
-          "faq" : {
-            "type" : [ "string", "null" ],
-            "description" : "faq threshold",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
-          },
-          "title" : {
-            "type" : [ "string", "null" ],
-            "description" : "title threshold",
-            "maxLength" : 100,
-            "minLength" : 0,
-            "pattern" : "([0-9]{1,13}(\\.[0-9]*)?)"
-          }
-        },
-        "required" : [ "common", "faq", "passage", "title" ]
-      }
-    },
-    "responses" : {
-      "endSession" : {
-        "description" : "endSession template definitions",
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "status" : {
-                  "type" : [ "boolean", "null" ],
-                  "description" : "",
-                  "x-custom-parameters-attributes" : { }
-                }
-              },
-              "required" : [ "status" ]
-            },
-            "examples" : {
-              "Valid responses Definitions" : {
-                "value" : { }
-              }
-            }
-          }
-        },
-        "x-custom-response-attributes" : { }
-      },
-      "startSession" : {
-        "description" : "startSession template definitions",
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "sessionId" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 100,
-                  "minLength" : 0
-                }
-              },
-              "required" : [ "sessionId" ]
-            },
-            "examples" : {
-              "Valid responses Definitions" : {
-                "value" : null
-              }
-            }
-          }
-        },
-        "x-custom-response-attributes" : {
-          "disable-safe-headers" : "[]"
-        }
-      }
-    },
-    "parameters" : {
-      "botId" : {
-        "name" : "botId",
-        "in" : "query",
-        "description" : "",
-        "required" : false,
-        "style" : "form",
-        "explode" : true,
-        "schema" : {
-          "type" : [ "string", "null", "integer" ],
-          "format" : "int64",
-          "description" : "",
-          "minimum" : 1,
-          "pattern" : "([0-9]+)",
-          "x-custom-parameters-attributes" : { }
-        }
-      },
-      "sessionId" : {
-        "name" : "sessionId",
-        "in" : "query",
-        "description" : "",
-        "required" : false,
-        "style" : "form",
-        "explode" : true,
-        "schema" : {
-          "type" : [ "string", "null" ],
-          "description" : "",
-          "maxLength" : 100,
-          "minLength" : 0,
-          "x-custom-parameters-attributes" : { }
-        }
-      }
-    },
-    "requestBodies" : {
-      "answerbotQuery" : {
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "accessType" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "permission accesstype",
-                  "enum" : [ "PRIVATE", "PUBLIC" ],
-                  "maxLength" : 100,
-                  "minLength" : 0
-                },
-                "question" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 5000,
-                  "minLength" : 1
-                },
-                "limit" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int32",
-                  "description" : "Number of doc answer, Max is 20",
-                  "maximum" : 20,
-                  "pattern" : "([0-9]+)"
-                },
-                "botId" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int64",
-                  "description" : "Answer botId",
-                  "minimum" : 1,
-                  "pattern" : "([0-9]+)"
-                },
-                "thresholdConfig" : {
-                  "$ref" : "./ZIAAnswerbotInference.json#/components/schemas/thresholdConfiguration"
-                },
-                "contentType" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "Answer content type",
-                  "enum" : [ "html", "text", "markdown" ],
-                  "maxLength" : 100,
-                  "minLength" : 1
-                }
-              }
-            },
-            "examples" : {
-              "Valid requestBody Definitions" : {
-                "value" : null
-              }
-            }
-          }
-        },
-        "x-custom-request-body-attributes" : {
-          "non-empty" : false,
-          "allow-invalid" : false
-        }
-      },
-      "answerbotPublicChat" : {
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "question" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 5000,
-                  "minLength" : 1
-                },
-                "botId" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int64",
-                  "description" : "Answer botId",
-                  "minimum" : 1,
-                  "pattern" : "([0-9]+)"
-                },
-                "thresholdConfig" : {
-                  "$ref" : "./ZIAAnswerbotInference.json#/components/schemas/thresholdConfiguration"
-                },
-                "sessionId" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "sessionId",
-                  "maxLength" : 100,
-                  "minLength" : 0,
-                  "x-custom-parameters-attributes" : {
-                    "secret" : true
-                  }
-                },
-                "contentType" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "Answer content type",
-                  "enum" : [ "html", "text", "markdown" ],
-                  "maxLength" : 100,
-                  "minLength" : 1
-                }
-              }
-            },
-            "examples" : {
-              "Valid requestBody Definitions" : {
-                "value" : null
-              }
-            }
-          }
-        },
-        "x-custom-request-body-attributes" : {
-          "non-empty" : false,
-          "allow-invalid" : false
-        }
-      },
-      "answerbotChat" : {
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "accessType" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "permission accesstype",
-                  "enum" : [ "PRIVATE", "PUBLIC" ],
-                  "maxLength" : 100,
-                  "minLength" : 0
-                },
-                "question" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 5000,
-                  "minLength" : 1
-                },
-                "botId" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int64",
-                  "description" : "Answer botId",
-                  "minimum" : 1,
-                  "pattern" : "([0-9]+)"
-                },
-                "thresholdConfig" : {
-                  "$ref" : "./ZIAAnswerbotInference.json#/components/schemas/thresholdConfiguration"
-                },
-                "sessionId" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "sessionId",
-                  "maxLength" : 100,
-                  "minLength" : 0,
-                  "x-custom-parameters-attributes" : {
-                    "secret" : true
-                  }
-                },
-                "contentType" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "Answer content type",
-                  "enum" : [ "html", "text", "markdown" ],
-                  "maxLength" : 100,
-                  "minLength" : 1
-                }
-              }
-            },
-            "examples" : {
-              "Valid requestBody Definitions" : {
-                "value" : null
-              }
-            }
-          }
-        },
-        "x-custom-request-body-attributes" : {
-          "non-empty" : false,
-          "allow-invalid" : false
-        }
-      },
-      "answerbotPublicQuery" : {
-        "content" : {
-          "application/json" : {
-            "schema" : {
-              "type" : [ "null", "object" ],
-              "additionalProperties" : false,
-              "properties" : {
-                "question" : {
-                  "type" : [ "string", "null" ],
-                  "maxLength" : 5000,
-                  "minLength" : 1
-                },
-                "limit" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int32",
-                  "description" : "Number of doc answer, Max is 20",
-                  "maximum" : 20,
-                  "pattern" : "([0-9]+)"
-                },
-                "botId" : {
-                  "type" : [ "string", "null", "integer" ],
-                  "format" : "int64",
-                  "description" : "Answer botId",
-                  "minimum" : 1,
-                  "pattern" : "([0-9]+)"
-                },
-                "thresholdConfig" : {
-                  "$ref" : "./ZIAAnswerbotInference.json#/components/schemas/thresholdConfiguration"
-                },
-                "contentType" : {
-                  "type" : [ "string", "null" ],
-                  "description" : "Answer content type",
-                  "enum" : [ "html", "text", "markdown" ],
-                  "maxLength" : 100,
-                  "minLength" : 1
-                }
-              }
-            },
-            "examples" : {
-              "Valid requestBody Definitions" : {
-                "value" : null
-              }
-            }
-          }
-        },
-        "x-custom-request-body-attributes" : {
-          "non-empty" : false,
-          "allow-invalid" : false
-        }
-      }
-    },
-    "securitySchemes" : {
-      "cookie-auth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
-      },
-      "org-oauth" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
-      },
-      "iam-oauth2-schema" : {
-        "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
-      }
-    }
-  },
-  "x-entity" : "ZIAAnswerbotInference"
-}