Publishing Azure AI Search connections

The Get Indexes
action retrieves the index definition. You must specify the name of the index that you want to retrieve and the API version to get the index details in the response.

For more information about configuring the parameters for the

Get Indexes

action, see the Azure AI Search documentation.

The Delete Indexes
action deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Ensure that you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to rebuild the index.

You must specify the index name that you want to delete and the API version. On successful deletion, you will receive the

204 No Content

status code in the response.

For more information about configuring the parameters for the

Delete Indexes

action, see the Azure AI Search documentation.

The Create Or Update Indexes
action creates an index with the given details or updates an existing index. You must specify the index name and the API version. The index details must be of the SearchIndex PO type.

Azure AI Search Connector in Application Integration does not support the

@odata.type

key. You must provide the

odataType

key instead.

If fields in the

requestBody

need to be in different formats, you must add additional namespaces as shown in the following sample code:

<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<name>hotels</name>
<fields m:isArray="true">
<name>HotelId</name>
<type>Edm.String</type>
<key m:type="xs:boolean">true</key>
<filterable m:type="xs:boolean">true</filterable>
</fields>
<fields>
<name>HotelName</name>
<type>Edm.String</type>
<searchable m:type="xs:boolean">true</searchable>
<filterable m:type="xs:boolean">false</filterable>
<sortable m:type="xs:boolean">true</sortable>
<facetable m:type="xs:boolean">false</facetable>
</fields>
<fields>
<name>Description</name>
<type>Edm.String</type>
<searchable>true</searchable>
<filterable m:type="xs:boolean">false</filterable>
<sortable m:type="xs:boolean">false</sortable>
<facetable m:type="xs:boolean">false</facetable>
<analyzer>en.microsoft</analyzer>
</fields>
<fields>
<name>Category</name>
<type>Edm.String</type>
<searchable m:type="xs:boolean">true</searchable>
<filterable m:type="xs:boolean">true</filterable>
<sortable m:type="xs:boolean">true</sortable>
<facetable m:type="xs:boolean">true</facetable>
</fields>
<fields>
<name>Tags</name>
<type>Collection(Edm.String)</type>
<searchable m:type="xs:boolean">true</searchable>
<filterable m:type="xs:boolean">true</filterable>
<sortable m:type="xs:boolean">false</sortable>
<facetable m:type="xs:boolean">true</facetable>
<analyzer>tagsAnalyzer</analyzer>
</fields>
<fields>
<name>Rating</name>
<type>Edm.Double</type>
<filterable m:type="xs:boolean">true</filterable>
<sortable m:type="xs:boolean">true</sortable>
<facetable m:type="xs:boolean">true</facetable>
</fields>
<fields>
<name>Address</name>
<type>Edm.ComplexType</type>
<fields>
<name>City</name>
<type>Edm.String</type>
<searchable m:type="xs:boolean">true</searchable>
<filterable m:type="xs:boolean">true</filterable>
<sortable m:type="xs:boolean">true</sortable>
<facetable m:type="xs:boolean">true</facetable>
</fields>
<fields>
<name>Country</name>
<type>Edm.String</type>
<searchable m:type="xs:boolean">true</searchable>
<filterable m:type="xs:boolean">true</filterable>
<sortable m:type="xs:boolean">true</sortable>
<facetable m:type="xs:boolean">true</facetable>
</fields>
</fields>
<suggesters m:isArray="true">
<name>sg</name>
<searchMode>analyzingInfixMatching</searchMode>
<sourceFields m:isArray="true">HotelName</sourceFields>
<sourceFields m:isArray="true">Description</sourceFields>
</suggesters>
<analyzers m:isArray="true">
<odataType>#Microsoft.Azure.Search.CustomAnalyzer</odataType>
<name>tagsAnalyzer</name>
<charFilters m:isArray="true">html_strip</charFilters>
<tokenizer>standard_v2</tokenizer>
</analyzers>
</root>

You will receive the

201 Created

status code in the response and the index details if a new index is created. If the index is updated, you will receive the

204 No Content

status code in the response.

For more information about configuring the parameters for the

Create Or Update Indexes

action, see the Azure AI Search documentation.

The Get Statistics Indexes
action returns statistics for the given index, including a document count and storage usage. You must specify the index name for which you want to get the statistic and specify the API version.

You will receive the

200

status code and the statistics of GetIndexStatisticsResult in the response.

For more information about configuring the parameters for the

Get Statistics Indexes

action, see the Azure AI Search documentation.

The Suggest Documents
action suggests documents in the index that match the given partial query text. You must specify the index name that you want to get document suggestions from and specify the API version.

You must provide the suggest parameters object in which the search, select
, and other parameters are available.

You can get the suggested document only if you have any suggester configured in the index. The

suggesterName

parameter is required.

The following snippet is a sample to build a

requestBody

object:

<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<filter>Rating gt 4.0</filter>
<minimumCoverage m:type="xs:int">80</minimumCoverage>
<orderby>Rating desc</orderby>
<search>hote</search>
<suggesterName>sg</suggesterName>
<top m:type="xs:int">10</top>
</root>

You will receive the documents that meet the query criteria in the response.

For more information about configuring the parameters for the Suggest Documents
action, see the Azure AI Search documentation.

The Search Documents
action searches for documents in the index. You must specify the index name that you want to search in and specify the API version. You must provide the search parameters object with the search query and other parameters. Otherwise, all documents will be returned.

The following snippet is a sample to build a

requestBody

object:

<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
     <count m:type="xs:boolean">true</count>
     <filter>Rating gt 1.0</filter>
     <minimumCoverage m:type="xs:int">80</minimumCoverage>
     <orderby>Rating desc</orderby>
     <search>tranquil ambiance</search>
     <searchFields>Category,Description</searchFields>
     <select>HotelName</select>
     <captions>none</captions>
</root>

You will receive the documents that meet the query criteria in the response.

For more information about configuring the parameters for the Search Documents
action, see the Azure AI Search documentation.

The Lookup Document
action retrieves a document from Azure AI Search. You can retrieve any document from the index with the document ID.

The index name, document key, and API version are the required fields. If you want to retrieve any particular field(s) value, you specify it in the select
field. You can specify a list of comma-separated fields to retrieve the documents. The default value of the select
field is *. You will receive the document in the response if it exists.

The Create Or Update DataSource
action creates the data source with the given details or updates the data source if it exists. You must specify the data source name and the API version. Data source details must be of the SearchIndexerDataSource PO type.

The following snippet is a sample to build a

requestBody

object:

<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<name>hotel-ds</name>
<description>My Azure hotel table data source.</description>
<type>azuretable</type>
<credentials>    <connectionString>DefaultEndpointsProtocol=https;AccountName=rnddev;AccountKey=Ax/ibOkbZ06jklzGfTrM9+AStGCdv7Q==;EndpointSuffix=core.windows.net</connectionString>
</credentials>
<container>
    <name>hotelDetails</name>
</container>
<dataDeletionDetectionPolicy>
    <odataType>#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy</odataType>
    <softDeleteColumnName>isDeleted</softDeleteColumnName>
    <softDeleteMarkerValue >true</softDeleteMarkerValue>
</dataDeletionDetectionPolicy>
</root>

You will receive the

201 Created

status code and the data source details if a new data source is created. If the data source is updated, you will receive the

204 No Content

status code.

Azure AI Search Connector in Application Integration does not support the

@odata.type

key. You must provide the

odataType

key instead.

For more information about configuring the parameters for the Create Or Update DataSource
action, see the Azure AI Search documentation.

The List DataSources
action lists all the data sources available for a search service.

The API version is the required parameter. In the select
field, you can specify the field names that you want to retrieve. You can specify a comma-separated list of JSON property names, or * for all the properties. The default is all properties.

The response returns a list of SerchIndexerDataSource PO types.

For more information about configuring the parameters for the List DataSource
action, see the Azure AI Search documentation.

The Get DataSource
action retrieves a data source definition of a particular data source by name.

The data source name and API version are the required fields. The data source details will be retrieved in the response if the data source exists.

For more information about configuring the parameters for the Get DataSource
action, see the Azure AI Search documentation.

The Delete DataSource
action deletes the data source if it exists in the search service. This operation is permanent, with no recovery option.

The data source name and API version are the required fields. On successful deletion, you will receive the

204 No Content

status code in the response.

For more information about configuring the parameters for the Delete DataSource
action, see the Azure AI Search documentation.

The List Indexes
action lists all the indexes available for a search service.

The API version is the required field. In the select
field, you can specify the field names that you want to retrieve. You can specify a comma-separated list of JSON property names, or * for all the properties. The default is all properties. The response returns a list of SerchIndex PO types.

For more information about configuring the parameters for the List Indexes
action, see the Azure AI Search documentation.

The List Indexers
action lists all indexers available for a search service.

The API version is the required field. In the select
field, you can specify the field names that you want to retrieve. You can specify a comma-separated list of JSON property names, or * for all the properties. The default is all properties. The response returns a list of SerchIndexer PO types.

For more information about configuring the parameters for the List Indexers
action, see the Azure AI Search documentation.

The Create Or Update Indexers
action creates a new indexer or updates an indexer if it already exists.

You must specify the indexer name and the API version. The indexer details must be of the SearchIndexer PO type.

The following snippet is a sample to build a

requestBody

object:

<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<name>hotels-indexer</name>
<description>a indexer for hotels</description>
<dataSourceName>hotel-ds</dataSourceName>
<targetIndexName>hotels</targetIndexName>
<schedule>
    <interval>PT1H</interval>
    <startTime>2024-01-01T00:00:00Z</startTime>
</schedule>
<parameters>
    <maxFailedItems m:type="xs:int">10</maxFailedItems>
    <maxFailedItemsPerBatch m:type="xs:int">5</maxFailedItemsPerBatch>
</parameters>
</root>

You will receive the

201 Created

status code and the indexer details if a new indexer is created. If the indexer is updated, you will receive the

204 No Content

status code in the response.

Azure AI Search Connector in Application Integration does not support the

@odata.type

key. You must provide the

odataType

key instead.

For more information about configuring the parameters for the Create Or Update Indexers
action, see the Azure AI Search documentation.

The Delete Indexer
action deletes the indexer if it exists in the search service. This operation is permanent, with no recovery option.

The indexer name and API version are the required fields. On successful deletion, you will receive the

204 No Content

status code in the response.

For more information about configuring the parameters for the Delete Indexer
action, see the Azure AI Search documentation.

The Get Indexer
action retrieves an indexer definition by name.

The indexer name and API version are the required fields. The indexer details of the SearchIndexer PO type are retrieved if the indexer exists.

For more information about configuring the parameters for the Get Indexer
action, see the Azure AI Search documentation.

The Get Status Indexer
action returns the current status, last result, and execution history of an indexer.

The indexer name and API version are the required fields. If the indexer exists, the response returns a list of SearchIndexerStatus type.

For more information about configuring the parameters for the Get Status Indexer
action, see the Azure AI Search documentation.

The Run Indexers
action runs an indexer on demand. The indexer name and API version are the required fields. On a successful run, you will receive the

202 Accepted

status code.

For more information about configuring the parameters for the Run Indexers
action, see the Azure AI Search documentation.

The Reset Indexer
action resets the change tracking state associated with an indexer. The indexer name and API version are the required fields. On successful reset, you will receive the

202 Accepted

status code.

For more information about configuring the parameters for the Reset Indexer
action, see the Azure AI Search documentation.

The Create Or Update Skillsets
action creates a new skillset in a search service or updates the skillset if it already exists. You can specify the skillset name and the API version. The skillset details must be of the SearchIndexerSkillset PO type.

The following snippet is a sample to build a

requestBody

object:

<root xmlns:m="urn:informatica:ae:xquery:json2xml:meta-data">
<name>demoskillset2</name>
<description>A skillset to demonstrate capabilities</description>
<skills m:isArray="true">
    <odataType>#Microsoft.Skills.Text.KeyPhraseExtractionSkill</odataType>
    <name>keyPhraseExtractionSkill</name>
    <description>Extracts key phrases from the text.</description>
    <context>/document</context>
    <inputs m:isArray="true">
        <name>text</name>
        <source>/document/mergedText</source>
    </inputs>
    <outputs  m:isArray="true">
        <name>keyPhrases</name>
        <targetName>keyPhrases</targetName>
    </outputs>
</skills>
</root>

You will receive the

201 Created

status code and the skillset details if a new skillset is created. If the skillset is updated, you will receive the

204 No Content

status code in the response.

Azure AI Search Connector in Application Integration does not support the

@odata.type

key. You must provide the

odataType

key instead.

For more information about configuring the parameters for the Create Or Update Skillsets
action, see the Azure AI Search documentation.

The List SkillSets
action lists all the skillsets available for a search service.

The API version is the required field. In the select
field, you can specify the field names that you want to retrieve. You can specify a comma-separated list of JSON property names, or * for all the properties. The default is all properties. The response returns a list of SearchIndexerSkillset PO types.

For more information about configuring the parameters for the List SkillSets
action, see the Azure AI Search documentation.

The Get SkillSets
action retrieves a skillset definition in the search service by name.

The skillset name and API version are the required fields. The skillset details of the SearchIndexerSkillset PO type are retrieved if the skillset exists.

For more information about configuring the parameters for the Get SkillSets
action, see the Azure AI Search documentation.

The Delete SkillSets
action deletes the skillset if it exists in the search service. This operation is permanent, with no recovery option.

The skillset name and API version are the required fields. On successful deletion, you will receive the

204 No Content

status code in the response.

For more information about configuring the parameters for the Delete SkillSets
action, see the Azure AI Search documentation.

The Index Documents
action sends a batch of documents to insert, update, and delete in the index.

The batch, API version, index name, and action are the required fields. The batch is a list of documents. With every document, there is an action to be performed. The actions can be upload, merge, mergeOrupload, or delete. The object must contain the fields of the document.

Azure AI Search Connector in Application Integration does not support the

@search.action

key. You must provide the

search.action

key instead.

The status, StatusCode, and ErrorMessage of the operations of all the documents in the batch are received in the response.

For more information about configuring the parameters for the Index Documents
action, see the Azure AI Search documentation.

Table of Contents

Azure AI Search Connector Guide

Azure AI Search Connector Guide