Azure · admayber · Jul 30, 2025 · Jul 8, 2025 · Jul 8, 2025 · Jul 9, 2025
@@ -0,0 +1,112 @@
+{
+  "operationId": "KnowledgeRetrieval_Retrieve",
+  "title": "KnowledgeAgentRetrieve",
+  "parameters": {
+    "endpoint": "https://previewexampleservice.search.windows.net",
+    "agentName": "agent-preview-test",
+    "api-version": "2025-08-01-preview",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "x-ms-query-source-authorization": null,
+    "retrievalRequest": {
+      "messages": [
+        {
+          "role": "user",
+          "content": [
+            {
+              "text": "hello world",
+              "type": "text"
+            }
+          ]
+        }
+      ],
+      "knowledgeSourceParams": [
+        {
+          "knowledgeSourceName": "ks-preview-test",
+          "filterAddOn": "foo eq bar",
+          "maxDocsForReranker": 100,
+          "rerankerThreshold": 2.5,
+          "includeReferenceSourceData": true,
+          "kind": "searchIndex"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "response": [
+          {
+            "role": "assistant",
+            "content": [
+              {
+                "type": "text",
+                "text": "[{...}]"
+              }
+            ]
+          }
+        ],
+        "activity": [
+          {
+            "type": "modelQueryPlanning",
+            "id": 0,
+            "inputTokens": 11,
+            "outputTokens": 22
+          },
+          {
+            "type": "searchQuery",
+            "id": 1,
+            "targetIndex": "preview-test",
+            "query": {
+              "search": "hello world"
+            },
+            "queryTime": "2025-01-01T00:08:45.045Z",
+            "count": 2,
+            "elapsedMs": 1234
+          },
+          {
+            "type": "searchQuery",
+            "id": 2,
+            "targetIndex": "preview-test",
+            "query": {
+              "search": "hello world two"
+            },
+            "queryTime": "2025-01-01T00:08:45.045Z",
+            "count": 2,
+            "elapsedMs": 1234
+          },
+          {
+            "type": "searchSemanticReranker",
+            "id": 3,
+            "inputTokens": 74
+          }
+        ],
+        "references": [
+          {
+            "type": "searchDoc",
+            "id": "83dd7d40",
+            "activitySource": 1,
+            "docKey": "myDocKey1",
+            "sourceData": {
+              "id": "myDocKey1",
+              "title": "high_doc",
+              "content": "hello world"
+            },
+            "rerankerScore": 3.5
+          },
+          {
+            "type": "searchDoc",
+            "id": "83dd7d41",
+            "activitySource": 1,
+            "docKey": "myDocKey2",
+            "sourceData": {
+              "id": "myDocKey2",
+              "title": "low_doc",
+              "content": "goodbye world"
+            },
+            "rerankerScore": 2.7
+          }
+        ]
+      }
+    }
+  }
+}
@@ -0,0 +1,38 @@
+{
+  "parameters": {
+    "endpoint": "https://myservice.search.windows.net",
+    "indexName": "myindex",
+    "api-version": "2025-08-01-preview",
+    "autocompleteMode": "oneTerm",
+    "search": "washington medic",
+    "suggesterName": "sg",
+    "filter": "search.in(docId,'101,102,105')",
+    "fuzzy": false,
+    "highlightPostTag": "</em>",
+    "highlightPreTag": "<em>",
+    "minimumCoverage": 80,
+    "searchFields": [
+      "title",
+      "description"
+    ],
+    "top": 10
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "text": "medicaid",
+          "queryPlusText": "washington medicaid"
+        },
+        {
+          "text": "medicare",
+          "queryPlusText": "washington medicare"
+        },
+        {
+          "text": "medicine",
+          "queryPlusText": "washington medicine"
+        }
+      ]
+    }
+  }
+}
@@ -0,0 +1,39 @@
+{
+  "operationId": "Documents_AutocompletePost",
+  "title": "SearchIndexAutocompleteDocumentsPost",
+  "parameters": {
+    "endpoint": "https://previewexampleservice.search.windows.net",
+    "indexName": "preview-test",
+    "api-version": "2025-08-01-preview",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "autocompleteRequest": {
+      "search": "p",
+      "autocompleteMode": "oneTerm",
+      "filter": "ownerId ne '1'",
+      "fuzzy": true,
+      "highlightPostTag": "</em>",
+      "highlightPreTag": "<em>",
+      "minimumCoverage": 80,
+      "searchFields": "category, ownerId",
+      "suggesterName": "sg",
+      "top": 10
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "@search.coverage": 100.0,
+        "value": [
+          {
+            "text": "purple",
+            "queryPlusText": "<em>purple</em>"
+          },
+          {
+            "text": "pink",
+            "queryPlusText": "<em>pink</em>"
+          }
+        ]
+      }
+    }
+  }
+}
@@ -0,0 +1,15 @@
+{
+  "operationId": "Documents_Count",
+  "title": "SearchIndexCountDocuments",
+  "parameters": {
+    "endpoint": "https://previewexampleservice.search.windows.net",
+    "indexName": "preview-test",
+    "api-version": "2025-08-01-preview",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+  },
+  "responses": {
+    "200": {
+      "body": 50
+    }
+  }
+}
@@ -0,0 +1,30 @@
+{
+  "operationId": "Documents_Get",
+  "title": "SearchIndexGetDocument",
+  "parameters": {
+    "endpoint": "https://previewexampleservice.search.windows.net",
+    "indexName": "preview-test",
+    "key": "1",
+    "$select": [
+      "id",
+      "description",
+      "name",
+      "category",
+      "ownerId"
+    ],
+    "api-version": "2025-08-01-preview",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "x-ms-query-source-authorization": "00000000-0000-0000-0000-000000000000"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "1",
+        "name": "test",
+        "description": "test1 hello",
+        "category": "purple",
+        "ownerId": "sam"
+      }
+    }
+  }
+}