| 79 |
azure.search.documents.SearchClient.autocomplete |
def autocomplete( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 97 |
azure.search.documents.SearchClient.delete_documents |
def delete_documents( |
Leave the dedent entry in the docstring empty; do not assign a numerical value to it. |
| 122 |
azure.search.documents.SearchClient.merge_documents |
def merge_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to prevent hardcoding. |
| 128 |
azure.search.documents.SearchClient.merge_or_upload_documents |
def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty, do not assign a numerical value to it to avoid hardcoding. |
| 135 |
azure.search.documents.SearchClient.search |
def search( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to avoid hardcoding. |
| 181 |
azure.search.documents.SearchClient.suggest |
def suggest( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to prevent hardcoding. |
| 198 |
azure.search.documents.SearchClient.upload_documents |
def upload_documents( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 233 |
azure.search.documents.SearchIndexingBufferedSender.delete_documents |
def delete_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 254 |
azure.search.documents.SearchIndexingBufferedSender.merge_documents |
def merge_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 261 |
azure.search.documents.SearchIndexingBufferedSender.merge_or_upload_documents |
def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 268 |
azure.search.documents.SearchIndexingBufferedSender.upload_documents |
def upload_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it. |
| 329 |
azure.search.documents.aio.SearchClient.autocomplete:async |
async def autocomplete( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it since hardcoding is discouraged. |
| 347 |
azure.search.documents.aio.SearchClient.delete_documents:async |
async def delete_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 372 |
azure.search.documents.aio.SearchClient.merge_documents:async |
async def merge_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to prevent hardcoding. |
| 378 |
azure.search.documents.aio.SearchClient.merge_or_upload_documents:async |
async def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it. |
| 385 |
azure.search.documents.aio.SearchClient.search:async |
async def search( |
Remove the hardcoded dedent value in the docstring and leave it empty to avoid assigning a numerical value. |
| 431 |
azure.search.documents.aio.SearchClient.suggest:async |
async def suggest( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 448 |
azure.search.documents.aio.SearchClient.upload_documents:async |
async def upload_documents( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 483 |
azure.search.documents.aio.SearchIndexingBufferedSender.delete_documents:async |
async def delete_documents( |
Do not hardcode dedent value; leave the dedent entry in your docstring empty to ensure flexibility. |
| 504 |
azure.search.documents.aio.SearchIndexingBufferedSender.merge_documents:async |
async def merge_documents( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 511 |
azure.search.documents.aio.SearchIndexingBufferedSender.merge_or_upload_documents:async |
async def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it. |
| 518 |
azure.search.documents.aio.SearchIndexingBufferedSender.upload_documents:async |
async def upload_documents( |
Leave the dedent entry in the docstring empty; do not assign a numerical value. |
| 1051 |
azure.search.documents.indexes.SearchIndexerClient.get_indexer_names |
def get_indexer_names(self, **kwargs: Any) -> Sequence[str]: ... |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding dedent values. |
| 1635 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer_names:async |
async def get_indexer_names(self, **kwargs) -> Sequence[str]: ... |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it. |
| 65 |
azure.search.documents.SearchClient |
class azure.search.documents.SearchClient(ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], SearchClientConfiguration]): implements ContextManager |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 104 |
azure.search.documents.SearchClient.get_document |
def get_document( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 315 |
azure.search.documents.aio.SearchClient |
class azure.search.documents.aio.SearchClient(ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], SearchClientConfiguration]): implements AsyncContextManager |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 354 |
azure.search.documents.aio.SearchClient.get_document:async |
async def get_document( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 540 |
azure.search.documents.indexes.SearchIndexClient.analyze_text |
def analyze_text( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 658 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_alias |
def create_or_update_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 667 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_index |
def create_or_update_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 731 |
azure.search.documents.indexes.SearchIndexClient.delete_alias |
def delete_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 740 |
azure.search.documents.indexes.SearchIndexClient.delete_index |
def delete_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 767 |
azure.search.documents.indexes.SearchIndexClient.delete_synonym_map |
def delete_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 783 |
azure.search.documents.indexes.SearchIndexClient.get_index |
def get_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 827 |
azure.search.documents.indexes.SearchIndexClient.get_synonym_map |
def get_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 837 |
azure.search.documents.indexes.SearchIndexClient.get_synonym_maps |
def get_synonym_maps( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 999 |
azure.search.documents.indexes.SearchIndexerClient.delete_data_source_connection |
def delete_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1008 |
azure.search.documents.indexes.SearchIndexerClient.delete_indexer |
def delete_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1026 |
azure.search.documents.indexes.SearchIndexerClient.get_data_source_connection |
def get_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1036 |
azure.search.documents.indexes.SearchIndexerClient.get_data_source_connections |
def get_data_source_connections( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1044 |
azure.search.documents.indexes.SearchIndexerClient.get_indexer |
def get_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1054 |
azure.search.documents.indexes.SearchIndexerClient.get_indexer_status |
def get_indexer_status( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1061 |
azure.search.documents.indexes.SearchIndexerClient.get_indexers |
def get_indexers( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1087 |
azure.search.documents.indexes.SearchIndexerClient.reset_indexer |
def reset_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1094 |
azure.search.documents.indexes.SearchIndexerClient.run_indexer |
def run_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1124 |
azure.search.documents.indexes.aio.SearchIndexClient.analyze_text:async |
async def analyze_text( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1242 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_alias:async |
async def create_or_update_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1251 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_index:async |
async def create_or_update_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1315 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_alias:async |
async def delete_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1324 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_index:async |
async def delete_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1351 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_synonym_map:async |
async def delete_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1367 |
azure.search.documents.indexes.aio.SearchIndexClient.get_index:async |
async def get_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1411 |
azure.search.documents.indexes.aio.SearchIndexClient.get_synonym_map:async |
async def get_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1421 |
azure.search.documents.indexes.aio.SearchIndexClient.get_synonym_maps:async |
async def get_synonym_maps( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1583 |
azure.search.documents.indexes.aio.SearchIndexerClient.delete_data_source_connection:async |
async def delete_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1592 |
azure.search.documents.indexes.aio.SearchIndexerClient.delete_indexer:async |
async def delete_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1610 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_data_source_connection:async |
async def get_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1620 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_data_source_connections:async |
async def get_data_source_connections( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1628 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer:async |
async def get_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1638 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer_status:async |
async def get_indexer_status( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1645 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexers:async |
async def get_indexers( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1671 |
azure.search.documents.indexes.aio.SearchIndexerClient.reset_indexer:async |
async def reset_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1678 |
azure.search.documents.indexes.aio.SearchIndexerClient.run_indexer:async |
async def run_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
Current Task
Apply TypeSpec client customizations to address APIView feedback comments.
Package Name: azure-search-documents
Language: Python
APIView URL: https://spa.apiview.dev/review/e8d301b10edf4b29b346a87fa4905ea6?activeApiRevisionId=7234ecb987b64bc689d16969085cc7d1
Feedback to Address
APIView Comments (64 unresolved)
Constraints
Apply TypeSpec client customizations to resolve as many comments as possible
MUST consult: https://github.com/Azure/azure-rest-api-specs/blob/main/eng/common/knowledge/customizing-client-tsp.md
ONLY commit the client.tsp file(s). TypeSpec compilation regenerates output files (e.g. Swagger/OpenAPI JSON files in data-plane/) as a side effect - do NOT commit these generated files. Revert them before creating the pull request.
Update ONLY the client.tsp file(s) for the spec directory referenced by this APIView. Do not modify other spec directories, even if feedback mentions related namespaces.
Example of feedback that should only update
specification/ai/Azure.AI.Projects/client.tspand NOTspecification/ai/Azure.AI.Agents/client.tspeven though they mention Agents-related elements:azure.ai.projects.aio.operations.AgentsOperations.delete:async.returntype| Return 'None' on delete.azure.ai.projects.telemetry.trace_function| Does this need to be a public function?Output Requirements
If a Commit SHA is provided, use it as the base for your changes
Include the APIView URL in PR description
CRITICAL: You MUST update the PR description with two summary tables. Both tables are required even if the PR is long.
Use the exact column headers shown below for both tables. Do NOT rename, reword, reorder, or omit any column headers.
Table 1 – Addressed (Yes): Include one row for every feedback item (
LineNo+Element) where feedback was addressed or required no action. Use exactly this header:Table 2 – Not Addressed (No): Include one row for every feedback item (
LineNo+Element) where feedback could NOT be addressed. Use exactly this header:Every feedback item MUST appear in at least one table. Items typically appear in only one table, but may appear in both if a single feedback item contains multiple points (e.g. rename + type change) where some were addressed and others were not.
Note: If a review comment CANNOT be addressed, explanation comments MUST NOT be added to the
client.tspfile.ONLY explain in the "Reason Not Addressed" column why it could not be addressed.
Include SDK code customization guidance: https://github.com/Azure/autorest.python/blob/main/docs/customizations.md
Auto-generated by DelegateAPIViewFeedbackTool