Update README.md

README.md

@@ -86,8 +86,10 @@ print(doc)
 ## Examples
 
 ### markdown documentation format for api docs 
+
+#### Exmaple 1
 ```python
-swagger_docs = """
+raw_docs = """
 Method access
 HTTP
 JavaScript
@@ -216,7 +218,7 @@ Convert the above docs to markdown format.
 
 prompt = f"""
 <api_doc>
-{swagger_docs}
+{raw_docs}
 </api_doc>
 <question>
 {question}
@@ -230,8 +232,260 @@ doc = (
 )
 print(doc)
 ```
+#### Exmaple 2
+
+```python
+raw_docs = """
+Method access
+HTTP
+JavaScript
+Python
+Java
+GET
+https://slack.com/api/users.list
+Required scopes
+Bot tokens
+users:read
+User tokens
+users:read
+Legacy bot tokens
+bot
+Content types
+application/x-www-form-urlencoded
+Rate limits
+Tier 2
+Arguments
+Required arguments
+token
+token
+·Required
+Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
+
+Example
+xxxx-xxxxxxxxx-xxxx
+Optional arguments
+cursor
+string
+·Optional
+Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail.
+
+Example
+dXNlcjpVMDYxTkZUVDI=
+include_locale
+boolean
+·Optional
+Set this to true to receive the locale for users. Defaults to false
+
+Example
+true
+limit
+number
+·Optional
+The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors.
+
+Default
+0
+Example
+20
+team_id
+string
+·Optional
+encoded team id to list users in, required if org token is used
+
+Example
+T1234567890
+"""
+
+question = """
+Parse the docs to openapi json format.
+"""
+
+prompt = f"""
+<api_doc>
+{raw_docs}
+</api_doc>
+<question>
+{question}
+</question>
+<json>
+"""
+inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
+outputs = model.generate(**inputs, max_new_tokens=1800)
+doc = (
+    tokenizer.decode(outputs[0][inputs.input_ids.shape[-1]:], skip_special_tokens=True)
+)
+print(doc)
+```
+#### Example 4
+
+```python
+docs = """
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Slack API",
+    "description": "API for Slack",
+    "termsOfService": "https://slack.com/terms-of-service",
+    "contact": {
+      "name": "Slack",
+      "url": "https://slack.com",
+      "email": "[email protected]"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "https://www.apache.org/licenses/LICENSE-2.0"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://slack.com/api",
+      "description": "API server"
+    }
+  ],
+  "paths": {
+    "/chat/postMessage": {
+      "post": {
+        "description": "Send a message to a channel or user",
+        "parameters": [
+          {
+            "name": "token",
+            "in": "query",
+            "required": true,
+            "description": "Bot token or user token",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "channel",
+            "in": "query",
+            "required": true,
+            "description": "The ID of the channel or user to send the message to",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "text",
+            "in": "query",
+            "required": true,
+            "description": "The message content",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "as_user",
+            "in": "query",
+            "required": false,
+            "description": "Pass true to post the message as the authed user instead of as a bot",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "name": "icon_emoji",
+            "in": "query",
+            "required": false,
+            "description": "Emoji to use as the icon for this message",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "icon_url",
+            "in": "query",
+            "required": false,
+            "description": "URL to an image to use as the icon for this message",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "link_names",
+            "in": "query",
+            "required": false,
+            "description": "Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "name": "unfurl_links",
+            "in": "query",
+            "required": false,
+            "description": "Pass true to enable unfurling of primarily text-based content",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "name": "unfurl_media",
+            "in": "query",
+            "required": false,
+            "description": "Pass false to disable unfurling of media content",
+            "schema": {
+              "type": "boolean"
+            }
+          },
+          {
+            "name": "username",
+            "in": "query",
+            "required": false,
+            "description": "Set your bot's user name",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "schema": {
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  }
+}
 
 
+instructions = f"""
+- Use base url: "https://slack.com/api"
+- Use above api docs.
+- Use and import requests library.
+- strictly show the reponse in code.
+"""
+
+question = """
+Send message 'Hi, please do check the https://pipable.ai', to channel '@general'.
+Use token as 'xoxb-123123123123-12312312312312-XxxxxxXXxxxx'
+""""
 
+prompt = f"""
+<docs>
+{docs}
+</docs>
+<instructions>
+{instructions}
+</instructions>
+<question>
+Write a python code for question:
+{question}
+</question>
+<python_code>
+"""
+
+inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
+outputs = model.generate(**inputs, max_new_tokens=500)
+code = (
+    tokenizer.decode(outputs[0][inputs.input_ids.shape[-1]:], skip_special_tokens=True)
+)
+print(code)
+
+```
 ### Team
 Avi Kothari, Pratham Gupta, Ritvik Aryan Kalra, Soham Acharya , Gyan Ranjan