SearchIndexClient Class

public AnalyzeResult analyzeText(String name, AnalyzeTextOptions request)

Shows how an analyzer breaks text into tokens.

Parameters:

Returns:

public Response<AnalyzeResult> analyzeTextWithResponse(String name, AnalyzeTextOptions request, RequestOptions requestOptions)

Shows how an analyzer breaks text into tokens.

Parameters:

Returns:

public static List<SearchField> buildSearchFields(Class<?> model)

Convenience method to convert a Class's Fields and Methods annotated with either BasicField or ComplexField into SearchField to help aid the creation of a SearchField which represents the Class.

This helper only inspects fields and methods declared by the model, and uses the following rules for creating SearchField:

• If the field or method is annotated with BasicField the SearchFieldDataType inferred by the type of the field or return type of the method cannot be COMPLEX. It may be a collection(SearchFieldDataType dataType) though.
• If the field or method is annotated with ComplexField the SearchFieldDataType inferred by the type of the field or return type of the method must be COMPLEX. It may be a collection(SearchFieldDataType dataType) of COMPLEX.
• If the field or method isn't annotated with either BasicField or ComplexField it will be ignored.

If the type of the field or return type of the method is an array or Iterable it will be considered a collection(SearchFieldDataType dataType) type. Nested collection(SearchFieldDataType dataType) aren't allowed and will throw an exception, ex. String[][], List>, List, List[], etc.

| Java type                                                                                        | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType"></xref>                                             |
| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `byte`                                                                                           | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.SBYTE" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#SBYTE"></xref>                                 |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Byte"></xref>                   | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.SBYTE" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#SBYTE"></xref>                                 |
| `boolean`                                                                                        | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.BOOLEAN" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#BOOLEAN"></xref>                             |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Boolean"></xref>                | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.BOOLEAN" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#BOOLEAN"></xref>                             |
| `short`                                                                                          | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.INT16" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#INT16"></xref>                                 |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Short"></xref>                  | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.INT16" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#INT16"></xref>                                 |
| `int`                                                                                            | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.INT32" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#INT32"></xref>                                 |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Integer"></xref>                | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.INT32" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#INT32"></xref>                                 |
| `long`                                                                                           | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.INT64" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#INT64"></xref>                                 |
| <xref uid="java.lang.Long" data-throw-if-not-resolved="false" data-raw-source="Long"></xref>     | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.INT64" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#INT64"></xref>                                 |
| `float`                                                                                          | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.SINGLE" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#SINGLE"></xref>                               |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Float"></xref>                  | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.SINGLE" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#SINGLE"></xref>                               |
| `double`                                                                                         | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.DOUBLE" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#DOUBLE"></xref>                               |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Double"></xref>                 | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.DOUBLE" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#DOUBLE"></xref>                               |
| `char`                                                                                           | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.STRING" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#STRING"></xref>                               |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Character"></xref>              | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.STRING" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#STRING"></xref>                               |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="CharSequence"></xref>           | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.STRING" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#STRING"></xref>                               |
| <xref uid="java.lang.String" data-throw-if-not-resolved="false" data-raw-source="String"></xref> | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.STRING" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#STRING"></xref>                               |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="Date"></xref>                   | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.DATE_TIME_OFFSET" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#DATE_TIME_OFFSET"></xref>           |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="OffsetDateTime"></xref>         | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.DATE_TIME_OFFSET" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#DATE_TIME_OFFSET"></xref>           |
| <xref uid="" data-throw-if-not-resolved="false" data-raw-source="GeoPoint"></xref>               | <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.GEOGRAPHY_POINT" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#GEOGRAPHY_POINT"></xref>             |
| Any other type                                                                                   | Attempted to be consumed as <xref uid="com.azure.search.documents.indexes.models.SearchFieldDataType.COMPLEX" data-throw-if-not-resolved="false" data-raw-source="SearchFieldDataType#COMPLEX"></xref> |

HALF and BYTE aren't supported by Field given there isn't a built-in Java type that represents them.

When generating SearchField there is a maximum class depth limit of 1000 before an exception will be thrown.

This helper method performs a few basic validation on the created SearchField, they are the following:

• If isHidden() and isRetrievable() must have different BasicField.BooleanHelper values or both be set to NULL.
• If isSearchable() is true, then the inferred SearchFieldDataType must be one of STRING, collection(SearchFieldDataType dataType) of STRING, or collection(SearchFieldDataType dataType) of SINGLE.
• If analyzerName() is set, both searchAnalyzerName() and indexAnalyzerName() must be empty.
• If searchAnalyzerName() is set then indexAnalyzerName() must be set and vice versa.
• If normalizerName() is set the inferred SearchFieldDataType must be either STRING or collection(SearchFieldDataType dataType) of STRING and have one or more of isFacetable() , isFilterable(), or isSortable() set to true.
• If one of vectorSearchDimensions() or vectorSearchProfileName() is set the other must be set as well.

Parameters:

Returns:

public SearchAlias createAlias(SearchAlias alias)

Creates a new search alias.

Parameters:

Returns:

public Response<SearchAlias> createAliasWithResponse(SearchAlias alias, RequestOptions requestOptions)

Creates a new search alias.

Parameters:

Returns:

public SearchIndex createIndex(SearchIndex index)

Creates a new search index.

Parameters:

Returns:

public Response<SearchIndex> createIndexWithResponse(SearchIndex index, RequestOptions requestOptions)

Creates a new search index.

Parameters:

Returns:

public KnowledgeBase createKnowledgeBase(KnowledgeBase knowledgeBase)

Creates a new knowledge base.

Parameters:

Returns:

public Response<KnowledgeBase> createKnowledgeBaseWithResponse(KnowledgeBase knowledgeBase, RequestOptions requestOptions)

Creates a new knowledge base.

Parameters:

Returns:

public KnowledgeSource createKnowledgeSource(KnowledgeSource knowledgeSource)

Creates a new knowledge source.

Parameters:

Returns:

public Response<KnowledgeSource> createKnowledgeSourceWithResponse(KnowledgeSource knowledgeSource, RequestOptions requestOptions)

Creates a new knowledge source.

Parameters:

Returns:

public SearchAlias createOrUpdateAlias(SearchAlias alias)

Creates a new search alias or updates an alias if it already exists.

Parameters:

Returns:

public Response<SearchAlias> createOrUpdateAliasWithResponse(SearchAlias alias, RequestOptions requestOptions)

Creates a new search alias or updates an alias if it already exists.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public SearchIndex createOrUpdateIndex(SearchIndex index)

Creates a new search index or updates an index if it already exists.

Parameters:

Returns:

public Response<SearchIndex> createOrUpdateIndexWithResponse(SearchIndex index, RequestOptions requestOptions)

Creates a new search index or updates an index if it already exists.

Query Parameters

| ------------------ | ------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name               | Type    | Required | Description                                                                                                                                                                                                                                                                                                                                                     |
| allowIndexDowntime | Boolean | No       | Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. |

You can add these to a request with RequestOptions#addQueryParam

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public KnowledgeBase createOrUpdateKnowledgeBase(KnowledgeBase knowledgeBase)

Creates a new knowledge base or updates a knowledge base if it already exists.

Parameters:

Returns:

public Response<KnowledgeBase> createOrUpdateKnowledgeBaseWithResponse(KnowledgeBase knowledgeBase, RequestOptions requestOptions)

Creates a new knowledge base or updates a knowledge base if it already exists.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public KnowledgeSource createOrUpdateKnowledgeSource(KnowledgeSource knowledgeSource)

Creates a new knowledge source or updates an knowledge source if it already exists.

Parameters:

Returns:

public Response<KnowledgeSource> createOrUpdateKnowledgeSourceWithResponse(KnowledgeSource knowledgeSource, RequestOptions requestOptions)

Creates a new knowledge source or updates an knowledge source if it already exists.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public SynonymMap createOrUpdateSynonymMap(SynonymMap synonymMap)

Creates a new synonym map or updates a synonym map if it already exists.

Parameters:

Returns:

public Response<SynonymMap> createOrUpdateSynonymMapWithResponse(SynonymMap synonymMap, RequestOptions requestOptions)

Creates a new synonym map or updates a synonym map if it already exists.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public SynonymMap createSynonymMap(SynonymMap synonymMap)

Creates a new synonym map.

Parameters:

Returns:

public Response<SynonymMap> createSynonymMapWithResponse(SynonymMap synonymMap, RequestOptions requestOptions)

Creates a new synonym map.

Parameters:

Returns:

public void deleteAlias(String name)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

Parameters:

public void deleteAlias(String name, MatchConditions matchConditions)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

Parameters:

public Response<Void> deleteAliasWithResponse(String name, RequestOptions requestOptions)

Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public void deleteIndex(String name)

Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure 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 re-build the index.

Parameters:

public void deleteIndex(String name, MatchConditions matchConditions)

Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure 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 re-build the index.

Parameters:

public Response<Void> deleteIndexWithResponse(String name, RequestOptions requestOptions)

Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure 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 re-build the index.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public void deleteKnowledgeBase(String name)

Deletes a knowledge base.

Parameters:

public void deleteKnowledgeBase(String name, MatchConditions matchConditions)

Deletes a knowledge base.

Parameters:

public Response<Void> deleteKnowledgeBaseWithResponse(String name, RequestOptions requestOptions)

Deletes a knowledge base.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public void deleteKnowledgeSource(String name)

Deletes an existing knowledge source.

Parameters:

public void deleteKnowledgeSource(String name, MatchConditions matchConditions)

Deletes an existing knowledge source.

Parameters:

public Response<Void> deleteKnowledgeSourceWithResponse(String name, RequestOptions requestOptions)

Deletes an existing knowledge source.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public void deleteSynonymMap(String name)

Deletes a synonym map.

Parameters:

public void deleteSynonymMap(String name, MatchConditions matchConditions)

Deletes a synonym map.

Parameters:

public Response<Void> deleteSynonymMapWithResponse(String name, RequestOptions requestOptions)

Deletes a synonym map.

Header Parameters

| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Name          | Type   | Required | Description                                                                                                                    |
| If-Match      | String | No       | Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.             |
| If-None-Match | String | No       | Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. |

You can add these to a request with RequestOptions#addHeader

Parameters:

Returns:

public SearchAlias getAlias(String name)

Retrieves an alias definition.

Parameters:

Returns:

public Response<SearchAlias> getAliasWithResponse(String name, RequestOptions requestOptions)

Retrieves an alias definition.

Parameters:

Returns:

public String getEndpoint()

Gets the endpoint used to communicate with the Azure AI Search service.

Returns:

public SearchIndex getIndex(String name)

Retrieves an index definition.

Parameters:

Returns:

public GetIndexStatisticsResult getIndexStatistics(String name)

Returns statistics for the given index, including a document count and storage usage.

Parameters:

Returns:

public Response<GetIndexStatisticsResult> getIndexStatisticsWithResponse(String name, RequestOptions requestOptions)

Returns statistics for the given index, including a document count and storage usage.

Parameters:

Returns:

public Response<SearchIndex> getIndexWithResponse(String name, RequestOptions requestOptions)

Retrieves an index definition.

Parameters:

Returns:

public KnowledgeBase getKnowledgeBase(String name)

Retrieves a knowledge base definition.

Parameters:

Returns:

public Response<KnowledgeBase> getKnowledgeBaseWithResponse(String name, RequestOptions requestOptions)

Retrieves a knowledge base definition.

Parameters:

Returns:

public KnowledgeSource getKnowledgeSource(String name)

Retrieves a knowledge source definition.

Parameters:

Returns:

public KnowledgeSourceStatus getKnowledgeSourceStatus(String name)

Retrieves the status of a knowledge source.

Parameters:

Returns:

public Response<KnowledgeSourceStatus> getKnowledgeSourceStatusWithResponse(String name, RequestOptions requestOptions)

Retrieves the status of a knowledge source.

Parameters:

Returns:

public Response<KnowledgeSource> getKnowledgeSourceWithResponse(String name, RequestOptions requestOptions)

Retrieves a knowledge source definition.

Parameters:

Returns:

public SearchClient getSearchClient(String indexName)

Initializes a new SearchClient using the given index name and the same configuration as the SearchIndexClient.

Parameters:

Returns:

public SearchServiceStatistics getServiceStatistics()

Gets service level statistics for a search service.

Returns:

public Response<SearchServiceStatistics> getServiceStatisticsWithResponse(RequestOptions requestOptions)

Gets service level statistics for a search service.

Parameters:

Returns:

public SearchServiceVersion getServiceVersion()

Gets the SearchServiceVersion used to communicate with the Azure AI Search service.

Returns:

public SynonymMap getSynonymMap(String name)

Retrieves a synonym map definition.

Parameters:

Returns:

public Response<SynonymMap> getSynonymMapWithResponse(String name, RequestOptions requestOptions)

Retrieves a synonym map definition.

Parameters:

Returns:

public PagedIterable<SearchAlias> listAliases()

Lists all aliases available for a search service.

Returns:

public PagedIterable<SearchAlias> listAliases(RequestOptions requestOptions)

Lists all aliases available for a search service.

Parameters:

Returns:

public PagedIterable<SearchIndex> listIndexes()

Lists all indexes available for a search service.

Returns:

public PagedIterable<SearchIndex> listIndexes(RequestOptions requestOptions)

Lists all indexes available for a search service.

Query Parameters

| ------- | ------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name    | Type         | Required | Description                                                                                                                                                                                                 |
| $select | List<String> | No       | Selects which top-level properties to retrieve. Specified as a comma-separated list of JSON property names, or '\*' for all properties. The default is all properties. In the form of "," separated string. |

You can add these to a request with RequestOptions#addQueryParam

Parameters:

Returns:

public PagedIterable<SearchIndexResponse> listIndexesWithSelectedProperties()

Lists all indexes available for a search service.

Returns:

public PagedIterable<SearchIndexResponse> listIndexesWithSelectedProperties(List<String> select)

Lists all indexes available for a search service.

Parameters:

Returns:

public PagedIterable<String> listIndexNames()

Lists the names all indexes available for a search service.

Returns:

public PagedIterable<KnowledgeBase> listKnowledgeBases()

Lists all knowledge bases available for a search service.

Returns:

public PagedIterable<KnowledgeBase> listKnowledgeBases(RequestOptions requestOptions)

Lists all knowledge bases available for a search service.

Parameters:

Returns:

public PagedIterable<KnowledgeSource> listKnowledgeSources()

Lists all knowledge sources available for a search service.

Returns:

public PagedIterable<KnowledgeSource> listKnowledgeSources(RequestOptions requestOptions)

Lists all knowledge sources available for a search service.

Parameters:

Returns:

public PagedIterable<String> listSynonymMapNames()

Lists the names of all synonym maps available for a search service.

Returns:

public PagedIterable<SynonymMap> listSynonymMaps()

Lists all synonym maps available for a search service.

Returns: