Skip to content

azure-sdk-for-python/sdk/search models do not match Azure Portal AI Search JSON #44962

@StacyCMay

Description

@StacyCMay
  • Package Name: azure-search-documents
  • Package Version: 11.6.0
  • Operating System: linux
  • Python Version: 3.14.2

Describe the bug
The JSON created for indexes, indexers, skillsets, and datasources in the Azure Portal for AI Search does not match the JSON required by the AI Search Documents SDK (https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/search/azure-search-documents). This is problematic because when using the Azure Portal as the IDE for creating indexes, indexers, skillsets, and dataources, we cannot simply add the JSON produced by the Azure Portal AI Search resource into our pipeline to promote to the TST/STG/PRD environments without having to alter the component definition first.

To Reproduce
Steps to reproduce the behavior:

  1. Create AI Search Indexer using Azure Portal for AI Search
  2. Click Edit JSON once the Indexer is created
  3. Copy JSON in Editor window into json file to be stored in Git repo for CI/CD process
  4. Have CI/CD process attempt to create an AI Search Indexer using the azure-search-documents SDK

Expected behavior
Expected behaviour is that the AI Search SDK and the JSON in the AI Search editor match schematically.

Screenshots
N/A

Additional context
Attached example files.

dc-success-stories-idx-indexer (SDK Format).json

dc-success-stories-idx-indexer (AZ Portal Format).txt

Metadata

Metadata

Assignees

Labels

Searchcustomer-reportedIssues that are reported by GitHub users external to the Azure organization.needs-team-attentionWorkflow: This issue needs attention from Azure service team or SDK teamquestionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

Type

No type

Projects

Status

Untriaged

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions