diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7734d89098..9d1f815fbf 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -66849,6 +66849,9 @@ }, { "$ref": "#/components/parameters/issues-advanced-search" + }, + { + "$ref": "#/components/parameters/search-type" } ], "responses": { @@ -66907,6 +66910,9 @@ "examples": { "default": { "$ref": "#/components/examples/issue-search-result-item-paginated" + }, + "lexical-fallback": { + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" } } } @@ -66923,6 +66929,9 @@ }, "403": { "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" } }, "x-github": { @@ -321439,9 +321448,11 @@ } }, "issue-search-result-item-paginated": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -321541,6 +321552,21 @@ ] } }, + "issue-search-result-item-paginated-lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } + }, "label-search-result-item-paginated": { "value": { "total_count": 2, @@ -328226,6 +328252,19 @@ "type": "string" } }, + "search-type": { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 6a8a5c327b..b0b057f861 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -48504,6 +48504,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/issues-advanced-search" + - "$ref": "#/components/parameters/search-type" responses: '200': description: Response @@ -48551,6 +48552,8 @@ paths: examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" + lexical-fallback: + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" '503': "$ref": "#/components/responses/service_unavailable" '422': @@ -48559,6 +48562,8 @@ paths: "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -239503,9 +239508,11 @@ components: score: 1 node_id: MDQ6VXNlcjU4MzIzMQ== issue-search-result-item-paginated: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ -239593,6 +239600,19 @@ components: locked: true author_association: COLLABORATOR state_reason: completed + issue-search-result-item-paginated-lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, the response + includes search_type set to "lexical" and lexical_fallback_reason listing + the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - "..." label-search-result-item-paginated: value: total_count: 2 @@ -245513,6 +245533,23 @@ components: required: false schema: type: string + search-type: + name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid team-id: name: team_id description: The unique identifier of the team. diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 556b6582f0..2e68fa0fd1 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -66755,6 +66755,9 @@ }, { "$ref": "#/components/parameters/issues-advanced-search" + }, + { + "$ref": "#/components/parameters/search-type" } ], "responses": { @@ -66813,6 +66816,9 @@ "examples": { "default": { "$ref": "#/components/examples/issue-search-result-item-paginated" + }, + "lexical-fallback": { + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" } } } @@ -66829,6 +66835,9 @@ }, "403": { "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" } }, "x-github": { @@ -320593,9 +320602,11 @@ } }, "issue-search-result-item-paginated": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -320695,6 +320706,21 @@ ] } }, + "issue-search-result-item-paginated-lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } + }, "label-search-result-item-paginated": { "value": { "total_count": 2, @@ -327380,6 +327406,19 @@ "type": "string" } }, + "search-type": { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 6e2fd26e22..a17c8a171d 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -48427,6 +48427,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/issues-advanced-search" + - "$ref": "#/components/parameters/search-type" responses: '200': description: Response @@ -48474,6 +48475,8 @@ paths: examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" + lexical-fallback: + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" '503': "$ref": "#/components/responses/service_unavailable" '422': @@ -48482,6 +48485,8 @@ paths: "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -238807,9 +238812,11 @@ components: score: 1 node_id: MDQ6VXNlcjU4MzIzMQ== issue-search-result-item-paginated: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ -238897,6 +238904,19 @@ components: locked: true author_association: COLLABORATOR state_reason: completed + issue-search-result-item-paginated-lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, the response + includes search_type set to "lexical" and lexical_fallback_reason listing + the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - "..." label-search-result-item-paginated: value: total_count: 2 @@ -244817,6 +244837,23 @@ components: required: false schema: type: string + search-type: + name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid team-id: name: team_id description: The unique identifier of the team. diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 3ce4de2e50..163d1d8180 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -67151,6 +67151,9 @@ }, { "$ref": "#/components/parameters/issues-advanced-search" + }, + { + "$ref": "#/components/parameters/search-type" } ], "responses": { @@ -67209,6 +67212,9 @@ "examples": { "default": { "$ref": "#/components/examples/issue-search-result-item-paginated" + }, + "lexical-fallback": { + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" } } } @@ -67225,6 +67231,9 @@ }, "403": { "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" } }, "x-github": { @@ -323347,9 +323356,11 @@ } }, "issue-search-result-item-paginated": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -323449,6 +323460,21 @@ ] } }, + "issue-search-result-item-paginated-lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } + }, "label-search-result-item-paginated": { "value": { "total_count": 2, @@ -330134,6 +330160,19 @@ "type": "string" } }, + "search-type": { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } + }, "team-id": { "name": "team_id", "description": "The unique identifier of the team.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 4c77b20da0..911f57a147 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -48689,6 +48689,7 @@ paths: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" - "$ref": "#/components/parameters/issues-advanced-search" + - "$ref": "#/components/parameters/search-type" responses: '200': description: Response @@ -48736,6 +48737,8 @@ paths: examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" + lexical-fallback: + "$ref": "#/components/examples/issue-search-result-item-paginated-lexical-fallback" '503': "$ref": "#/components/responses/service_unavailable" '422': @@ -48744,6 +48747,8 @@ paths: "$ref": "#/components/responses/not_modified" '403': "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -240738,9 +240743,11 @@ components: score: 1 node_id: MDQ6VXNlcjU4MzIzMQ== issue-search-result-item-paginated: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ -240828,6 +240835,19 @@ components: locked: true author_association: COLLABORATOR state_reason: completed + issue-search-result-item-paginated-lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, the response + includes search_type set to "lexical" and lexical_fallback_reason listing + the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - "..." label-search-result-item-paginated: value: total_count: 2 @@ -246748,6 +246768,23 @@ components: required: false schema: type: string + search-type: + name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid team-id: name: team_id description: The unique identifier of the team. diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 2455f2de69..511d3240c8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -659612,6 +659612,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "responses": { @@ -663343,9 +663356,11 @@ }, "examples": { "default": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -663444,6 +663459,21 @@ } ] } + }, + "lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } } } } @@ -663573,6 +663603,32 @@ } } } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 1431dcb623..99aa116b3a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -98941,6 +98941,22 @@ paths: required: false schema: type: string + - name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid responses: '200': description: Response @@ -99167,9 +99183,11 @@ paths: - only_non_semantic_fields_requested examples: default: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ -99257,10 +99275,24 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed + lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, + the response includes search_type set to "lexical" and lexical_fallback_reason + listing the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - "..." '503': *113 '422': *15 '304': *35 '403': *27 + '401': *23 x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 4936cf17e2..536b5e0266 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -646059,6 +646059,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "responses": { @@ -649595,9 +649608,11 @@ }, "examples": { "default": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -649696,6 +649711,21 @@ } ] } + }, + "lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } } } } @@ -649825,6 +649855,32 @@ } } } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 9915d08300..5da299486f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -98479,6 +98479,22 @@ paths: required: false schema: type: string + - name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid responses: '200': description: Response @@ -98700,9 +98716,11 @@ paths: - only_non_semantic_fields_requested examples: default: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ -98790,10 +98808,24 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed + lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, + the response includes search_type set to "lexical" and lexical_fallback_reason + listing the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - "..." '503': *113 '422': *15 '304': *35 '403': *27 + '401': *23 x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 9b3e295da2..10468a718a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -674528,6 +674528,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "responses": { @@ -678396,9 +678409,11 @@ }, "examples": { "default": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -678497,6 +678512,21 @@ } ] } + }, + "lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } } } } @@ -678626,6 +678656,32 @@ } } } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 652e3465d7..30ab358181 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -99702,6 +99702,22 @@ paths: required: false schema: type: string + - name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid responses: '200': description: Response @@ -99956,9 +99972,11 @@ paths: - only_non_semantic_fields_requested examples: default: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ -100046,10 +100064,24 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed + lexical-fallback: + summary: Hybrid search with lexical fallback + description: When a hybrid or semantic search falls back to lexical, + the response includes search_type set to "lexical" and lexical_fallback_reason + listing the reasons. Items are the same shape as the default example. + value: + total_count: 280 + incomplete_results: false + search_type: lexical + lexical_fallback_reason: + - quoted_text + items: + - "..." '503': *113 '422': *15 '304': *35 '403': *27 + '401': *23 x-github: githubCloudOnly: false enabledForGitHubApps: true diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 13918a3a11..30846985d7 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -736583,6 +736583,19 @@ "schema": { "type": "string" } + }, + { + "name": "search_type", + "description": "The type of search to perform on issues. When not specified, the default is lexical search.\n\n- `semantic` — performs a pure semantic (vector) search using embedding-based understanding.\n- `hybrid` — combines semantic search with lexical search for best results.\n\nSemantic and hybrid search require authentication and are rate limited to 10 requests per minute.\nOnly applies to issue searches (`/search/issues`).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "semantic", + "hybrid" + ] + } } ], "responses": { @@ -740314,9 +740327,11 @@ }, "examples": { "default": { + "summary": "Hybrid search response", "value": { "total_count": 280, "incomplete_results": false, + "search_type": "hybrid", "items": [ { "url": "https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132", @@ -740415,6 +740430,21 @@ } ] } + }, + "lexical-fallback": { + "summary": "Hybrid search with lexical fallback", + "description": "When a hybrid or semantic search falls back to lexical, the response includes search_type set to \"lexical\" and lexical_fallback_reason listing the reasons. Items are the same shape as the default example.", + "value": { + "total_count": 280, + "incomplete_results": false, + "search_type": "lexical", + "lexical_fallback_reason": [ + "quoted_text" + ], + "items": [ + "..." + ] + } } } } @@ -740544,6 +740574,32 @@ } } } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } } }, "x-github": { diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 625be5975c..72e71de8b8 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -115066,6 +115066,22 @@ paths: required: false schema: type: string + - name: search_type + description: |- + The type of search to perform on issues. When not specified, the default is lexical search. + + - `semantic` — performs a pure semantic (vector) search using embedding-based understanding. + - `hybrid` — combines semantic search with lexical search for best results. + + Semantic and hybrid search require authentication and are rate limited to 10 requests per minute. + Only applies to issue searches (`/search/issues`). + in: query + required: false + schema: + type: string + enum: + - semantic + - hybrid responses: '200': description: Response @@ -115292,9 +115308,11 @@ paths: - only_non_semantic_fields_requested examples: default: + summary: Hybrid search response value: total_count: 280 incomplete_results: false + search_type: hybrid items: - url: https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132 repository_url: https://api.github.com/repos/batterseapower/pinyin-toolkit @@ {"code":"deadline_exceeded","msg":"operation timed out"}