Azure.Search (preview:2024-11-01)

2025/01/09 • 5 updated methods

Indexes_Create (updated)
Description Creates a new search index.
Reference Link ¶

⚶ Changes

{
  "#id": "Indexes_Create",
  "$parameters": {
    "index": {
      "$properties": {
        "vectorSearch": [
          {
            "vectorizers": {
              "$properties": [
                {
                  "#name": "kind",
                  "Enum": {
                    "new": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time."
                      ]
                    ],
                    "old": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time."
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "vectorSearch": [
          {
            "vectorizers": {
              "$properties": [
                {
                  "#name": "kind",
                  "Enum": {
                    "new": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time."
                      ]
                    ],
                    "old": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time."
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /indexes
{
index:
{
name: string ,
fields:
[
{
name: string ,
type: enum ,
key: boolean ,
retrievable: boolean ,
stored: boolean ,
searchable: boolean ,
filterable: boolean ,
sortable: boolean ,
facetable: boolean ,
analyzer: enum ,
searchAnalyzer: enum ,
indexAnalyzer: enum ,
normalizer: enum ,
dimensions: integer ,
vectorSearchProfile: string ,
vectorEncoding: enum ,
synonymMaps:
[
string ,
]
,
fields:
[
string ,
]
,
}
,
]
,
scoringProfiles:
[
{
name: string ,
text:
{
weights: object ,
}
,
functions:
[
{
type: string ,
fieldName: string ,
boost: number ,
interpolation: enum ,
}
,
]
,
functionAggregation: enum ,
}
,
]
,
defaultScoringProfile: string ,
corsOptions:
{
allowedOrigins:
[
string ,
]
,
maxAgeInSeconds: integer ,
}
,
suggesters:
[
{
name: string ,
searchMode: enum ,
sourceFields:
[
string ,
]
,
}
,
]
,
analyzers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
charFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
normalizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
encryptionKey:
{
keyVaultKeyName: string ,
keyVaultKeyVersion: string ,
keyVaultUri: string ,
accessCredentials:
{
applicationId: string ,
applicationSecret: string ,
}
,
identity:
{
@odata.type: string ,
}
,
}
,
similarity:
{
@odata.type: string ,
}
,
semantic:
{
defaultConfiguration: string ,
configurations:
[
{
name: string ,
prioritizedFields:
{
titleField:
{
fieldName: string ,
}
,
prioritizedContentFields:
[
{
fieldName: string ,
}
,
]
,
prioritizedKeywordsFields:
[
{
fieldName: string ,
}
,
]
,
}
,
}
,
]
,
}
,
vectorSearch:
{
profiles:
[
{
name: string ,
algorithm: string ,
vectorizer: string ,
compression: string ,
}
,
]
,
algorithms:
[
{
name: string ,
kind: enum ,
}
,
]
,
vectorizers:
[
{
name: string ,
kind: enum ,
}
,
]
,
compressions:
[
{
name: string ,
kind: enum ,
rerankWithOriginalVectors: boolean ,
defaultOversampling: number ,
rescoringOptions:
{
enableRescoring: boolean ,
defaultOversampling: number ,
rescoreStorageMethod: enum ,
}
,
truncationDimension: integer ,
}
,
]
,
}
,
@odata.etag: string ,
}
,
x-ms-client-request-id: string ,
api-version: string ,
}

⚐ Response (201)

{
name: string ,
fields:
[
{
name: string ,
type: enum ,
key: boolean ,
retrievable: boolean ,
stored: boolean ,
searchable: boolean ,
filterable: boolean ,
sortable: boolean ,
facetable: boolean ,
analyzer: enum ,
searchAnalyzer: enum ,
indexAnalyzer: enum ,
normalizer: enum ,
dimensions: integer ,
vectorSearchProfile: string ,
vectorEncoding: enum ,
synonymMaps:
[
string ,
]
,
fields:
[
string ,
]
,
}
,
]
,
scoringProfiles:
[
{
name: string ,
text:
{
weights: object ,
}
,
functions:
[
{
type: string ,
fieldName: string ,
boost: number ,
interpolation: enum ,
}
,
]
,
functionAggregation: enum ,
}
,
]
,
defaultScoringProfile: string ,
corsOptions:
{
allowedOrigins:
[
string ,
]
,
maxAgeInSeconds: integer ,
}
,
suggesters:
[
{
name: string ,
searchMode: enum ,
sourceFields:
[
string ,
]
,
}
,
]
,
analyzers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
charFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
normalizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
encryptionKey:
{
keyVaultKeyName: string ,
keyVaultKeyVersion: string ,
keyVaultUri: string ,
accessCredentials:
{
applicationId: string ,
applicationSecret: string ,
}
,
identity:
{
@odata.type: string ,
}
,
}
,
similarity:
{
@odata.type: string ,
}
,
semantic:
{
defaultConfiguration: string ,
configurations:
[
{
name: string ,
prioritizedFields:
{
titleField:
{
fieldName: string ,
}
,
prioritizedContentFields:
[
{
fieldName: string ,
}
,
]
,
prioritizedKeywordsFields:
[
{
fieldName: string ,
}
,
]
,
}
,
}
,
]
,
}
,
vectorSearch:
{
profiles:
[
{
name: string ,
algorithm: string ,
vectorizer: string ,
compression: string ,
}
,
]
,
algorithms:
[
{
name: string ,
kind: enum ,
}
,
]
,
vectorizers:
[
{
name: string ,
kind: enum ,
}
,
]
,
compressions:
[
{
name: string ,
kind: enum ,
rerankWithOriginalVectors: boolean ,
defaultOversampling: number ,
rescoringOptions:
{
enableRescoring: boolean ,
defaultOversampling: number ,
rescoreStorageMethod: enum ,
}
,
truncationDimension: integer ,
}
,
]
,
}
,
@odata.etag: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Indexes_List (updated)
Description Lists all indexes available for a search service.
Reference Link ¶

⚶ Changes

{
  "#id": "Indexes_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "vectorSearch": [
              {
                "vectorizers": {
                  "$properties": [
                    {
                      "#name": "kind",
                      "Enum": {
                        "new": [
                          [
                            "azureOpenAI",
                            "Generate embeddings using an Azure OpenAI resource at query time."
                          ],
                          [
                            "customWebApi",
                            "Generate embeddings using a custom web endpoint at query time."
                          ],
                          [
                            "aiServicesVision",
                            "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                          ],
                          [
                            "aml",
                            "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time."
                          ]
                        ],
                        "old": [
                          [
                            "azureOpenAI",
                            "Generate embeddings using an Azure OpenAI resource at query time."
                          ],
                          [
                            "customWebApi",
                            "Generate embeddings using a custom web endpoint at query time."
                          ],
                          [
                            "aiServicesVision",
                            "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                          ],
                          [
                            "aml",
                            "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time."
                          ]
                        ]
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /indexes
{
$select: string ,
x-ms-client-request-id: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
fields:
[
{
name: string ,
type: enum ,
key: boolean ,
retrievable: boolean ,
stored: boolean ,
searchable: boolean ,
filterable: boolean ,
sortable: boolean ,
facetable: boolean ,
analyzer: enum ,
searchAnalyzer: enum ,
indexAnalyzer: enum ,
normalizer: enum ,
dimensions: integer ,
vectorSearchProfile: string ,
vectorEncoding: enum ,
synonymMaps:
[
string ,
]
,
fields:
[
string ,
]
,
}
,
]
,
scoringProfiles:
[
{
name: string ,
text:
{
weights: object ,
}
,
functions:
[
{
type: string ,
fieldName: string ,
boost: number ,
interpolation: enum ,
}
,
]
,
functionAggregation: enum ,
}
,
]
,
defaultScoringProfile: string ,
corsOptions:
{
allowedOrigins:
[
string ,
]
,
maxAgeInSeconds: integer ,
}
,
suggesters:
[
{
name: string ,
searchMode: enum ,
sourceFields:
[
string ,
]
,
}
,
]
,
analyzers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
charFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
normalizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
encryptionKey:
{
keyVaultKeyName: string ,
keyVaultKeyVersion: string ,
keyVaultUri: string ,
accessCredentials:
{
applicationId: string ,
applicationSecret: string ,
}
,
identity:
{
@odata.type: string ,
}
,
}
,
similarity:
{
@odata.type: string ,
}
,
semantic:
{
defaultConfiguration: string ,
configurations:
[
{
name: string ,
prioritizedFields:
{
titleField:
{
fieldName: string ,
}
,
prioritizedContentFields:
[
{
fieldName: string ,
}
,
]
,
prioritizedKeywordsFields:
[
{
fieldName: string ,
}
,
]
,
}
,
}
,
]
,
}
,
vectorSearch:
{
profiles:
[
{
name: string ,
algorithm: string ,
vectorizer: string ,
compression: string ,
}
,
]
,
algorithms:
[
{
name: string ,
kind: enum ,
}
,
]
,
vectorizers:
[
{
name: string ,
kind: enum ,
}
,
]
,
compressions:
[
{
name: string ,
kind: enum ,
rerankWithOriginalVectors: boolean ,
defaultOversampling: number ,
rescoringOptions:
{
enableRescoring: boolean ,
defaultOversampling: number ,
rescoreStorageMethod: enum ,
}
,
truncationDimension: integer ,
}
,
]
,
}
,
@odata.etag: string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Indexes_CreateOrUpdate (updated)
Description Creates a new search index or updates an index if it already exists.
Reference Link ¶

⚶ Changes

{
  "#id": "Indexes_CreateOrUpdate",
  "$parameters": {
    "index": {
      "$properties": {
        "vectorSearch": [
          {
            "vectorizers": {
              "$properties": [
                {
                  "#name": "kind",
                  "Enum": {
                    "new": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time."
                      ]
                    ],
                    "old": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time."
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "vectorSearch": [
          {
            "vectorizers": {
              "$properties": [
                {
                  "#name": "kind",
                  "Enum": {
                    "new": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time."
                      ]
                    ],
                    "old": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time."
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "vectorSearch": [
          {
            "vectorizers": {
              "$properties": [
                {
                  "#name": "kind",
                  "Enum": {
                    "new": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time."
                      ]
                    ],
                    "old": [
                      [
                        "azureOpenAI",
                        "Generate embeddings using an Azure OpenAI resource at query time."
                      ],
                      [
                        "customWebApi",
                        "Generate embeddings using a custom web endpoint at query time."
                      ],
                      [
                        "aiServicesVision",
                        "Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API."
                      ],
                      [
                        "aml",
                        "Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Studio Model Catalog at query time."
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /indexes('{indexName}')
{
indexName: string ,
index:
{
name: string ,
fields:
[
{
name: string ,
type: enum ,
key: boolean ,
retrievable: boolean ,
stored: boolean ,
searchable: boolean ,
filterable: boolean ,
sortable: boolean ,
facetable: boolean ,
analyzer: enum ,
searchAnalyzer: enum ,
indexAnalyzer: enum ,
normalizer: enum ,
dimensions: integer ,
vectorSearchProfile: string ,
vectorEncoding: enum ,
synonymMaps:
[
string ,
]
,
fields:
[
string ,
]
,
}
,
]
,
scoringProfiles:
[
{
name: string ,
text:
{
weights: object ,
}
,
functions:
[
{
type: string ,
fieldName: string ,
boost: number ,
interpolation: enum ,
}
,
]
,
functionAggregation: enum ,
}
,
]
,
defaultScoringProfile: string ,
corsOptions:
{
allowedOrigins:
[
string ,
]
,
maxAgeInSeconds: integer ,
}
,
suggesters:
[
{
name: string ,
searchMode: enum ,
sourceFields:
[
string ,
]
,
}
,
]
,
analyzers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
charFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
normalizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
encryptionKey:
{
keyVaultKeyName: string ,
keyVaultKeyVersion: string ,
keyVaultUri: string ,
accessCredentials:
{
applicationId: string ,
applicationSecret: string ,
}
,
identity:
{
@odata.type: string ,
}
,
}
,
similarity:
{
@odata.type: string ,
}
,
semantic:
{
defaultConfiguration: string ,
configurations:
[
{
name: string ,
prioritizedFields:
{
titleField:
{
fieldName: string ,
}
,
prioritizedContentFields:
[
{
fieldName: string ,
}
,
]
,
prioritizedKeywordsFields:
[
{
fieldName: string ,
}
,
]
,
}
,
}
,
]
,
}
,
vectorSearch:
{
profiles:
[
{
name: string ,
algorithm: string ,
vectorizer: string ,
compression: string ,
}
,
]
,
algorithms:
[
{
name: string ,
kind: enum ,
}
,
]
,
vectorizers:
[
{
name: string ,
kind: enum ,
}
,
]
,
compressions:
[
{
name: string ,
kind: enum ,
rerankWithOriginalVectors: boolean ,
defaultOversampling: number ,
rescoringOptions:
{
enableRescoring: boolean ,
defaultOversampling: number ,
rescoreStorageMethod: enum ,
}
,
truncationDimension: integer ,
}
,
]
,
}
,
@odata.etag: string ,
}
,
allowIndexDowntime: boolean ,
x-ms-client-request-id: string ,
If-Match: string ,
If-None-Match: string ,
Prefer: string ,
api-version: string ,
}

⚐ Response (200)

{
name: string ,
fields:
[
{
name: string ,
type: enum ,
key: boolean ,
retrievable: boolean ,
stored: boolean ,
searchable: boolean ,
filterable: boolean ,
sortable: boolean ,
facetable: boolean ,
analyzer: enum ,
searchAnalyzer: enum ,
indexAnalyzer: enum ,
normalizer: enum ,
dimensions: integer ,
vectorSearchProfile: string ,
vectorEncoding: enum ,
synonymMaps:
[
string ,
]
,
fields:
[
string ,
]
,
}
,
]
,
scoringProfiles:
[
{
name: string ,
text:
{
weights: object ,
}
,
functions:
[
{
type: string ,
fieldName: string ,
boost: number ,
interpolation: enum ,
}
,
]
,
functionAggregation: enum ,
}
,
]
,
defaultScoringProfile: string ,
corsOptions:
{
allowedOrigins:
[
string ,
]
,
maxAgeInSeconds: integer ,
}
,
suggesters:
[
{
name: string ,
searchMode: enum ,
sourceFields:
[
string ,
]
,
}
,
]
,
analyzers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
tokenFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
charFilters:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
normalizers:
[
{
@odata.type: string ,
name: string ,
}
,
]
,
encryptionKey:
{
keyVaultKeyName: string ,
keyVaultKeyVersion: string ,
keyVaultUri: string ,
accessCredentials:
{
applicationId: string ,
applicationSecret: string ,
}
,
identity:
{
@odata.type: string ,
}
,
}
,
similarity:
{
@odata.type: string ,
}
,
semantic:
{
defaultConfiguration: string ,
configurations:
[
{
name: string ,
prioritizedFields:
{
titleField:
{
fieldName: string ,
}
,
prioritizedContentFields:
[
{
fieldName: string ,
}
,
]
,
prioritizedKeywordsFields:
[
{
fieldName: string ,
}
,
]
,
}
,
}
,
]
,
}
,
vectorSearch:
{
profiles:
[
{
name: string ,
algorithm: string ,
vectorizer: string ,
compression: string ,
}
,
]
,
algorithms:
[
{
name: string ,
kind: enum ,
}
,
]
,
vectorizers:
[
{
name: string ,
kind: enum ,
}
,
]
,
compressions:
[
{
name: string ,
kind: enum ,
rerankWithOriginalVectors: boolean ,
defaultOversampling: number ,
rescoringOptions:
{
enableRescoring: boolean ,
defaultOversampling: number ,
rescoreStorageMethod: enum ,
}
,
truncationDimension: integer ,
}
,
]
,
}
,
@odata.etag: string ,
}

⚐ Response (201)

{
name: string ,
fields:
[
{
name: string ,
type: enum ,
key: boolean ,
retrievable: boolean ,
stored: boolean ,
searchable: boolean ,
filterable: boolean ,
sortable: boolean ,
facetable: boolean ,
analyzer: enum ,
searchAnalyzer: enum ,
indexAnalyzer: