SynonymMaps | @azure/search-documents

Class representing a SynonymMaps.

Hierarchy

SynonymMaps

Index

Constructors

constructor

Methods

Constructors

constructor

new SynonymMaps(client: SearchServiceClientContext): SynonymMaps

- Defined in generated/service/operations/synonymMaps.ts:19
Create a SynonymMaps.

Parameters
- client: SearchServiceClientContext
  
  Reference to the service client.
Returns SynonymMaps

Methods

create

create(synonymMap: SynonymMap, options?: coreHttp.RequestOptionsBase): Promise<Models.SynonymMapsCreateResponse>
create(synonymMap: SynonymMap, callback: coreHttp.ServiceCallback<SynonymMap>): void
create(synonymMap: SynonymMap, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<SynonymMap>): void

- Defined in generated/service/operations/synonymMaps.ts:147
Creates a new synonym map.

Parameters
- synonymMap: SynonymMap
  
  The definition of the synonym map to create.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.SynonymMapsCreateResponse>

Promise<Models.SynonymMapsCreateResponse>
- Defined in generated/service/operations/synonymMaps.ts:152
Parameters
- synonymMap: SynonymMap
  
  The definition of the synonym map to create.
- callback: coreHttp.ServiceCallback<SynonymMap>
  
  The callback
Returns void
- Defined in generated/service/operations/synonymMaps.ts:158
Parameters
- synonymMap: SynonymMap
  
  The definition of the synonym map to create.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SynonymMap>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(synonymMapName: string, synonymMap: SynonymMap, options?: Models.SynonymMapsCreateOrUpdateOptionalParams): Promise<Models.SynonymMapsCreateOrUpdateResponse>
createOrUpdate(synonymMapName: string, synonymMap: SynonymMap, callback: coreHttp.ServiceCallback<SynonymMap>): void
createOrUpdate(synonymMapName: string, synonymMap: SynonymMap, options: SynonymMapsCreateOrUpdateOptionalParams, callback: coreHttp.ServiceCallback<SynonymMap>): void

- Defined in generated/service/operations/synonymMaps.ts:36
Creates a new synonym map or updates a synonym map if it already exists.

Parameters
- synonymMapName: string
  
  The name of the synonym map to create or update.
- synonymMap: SynonymMap
  
  The definition of the synonym map to create or update.
- Optional options: Models.SynonymMapsCreateOrUpdateOptionalParams
Returns Promise<Models.SynonymMapsCreateOrUpdateResponse>

Promise<Models.SynonymMapsCreateOrUpdateResponse>
- Defined in generated/service/operations/synonymMaps.ts:42
Parameters
- synonymMapName: string
  
  The name of the synonym map to create or update.
- synonymMap: SynonymMap
  
  The definition of the synonym map to create or update.
- callback: coreHttp.ServiceCallback<SynonymMap>
  
  The callback
Returns void
- Defined in generated/service/operations/synonymMaps.ts:49
Parameters
- synonymMapName: string
  
  The name of the synonym map to create or update.
- synonymMap: SynonymMap
  
  The definition of the synonym map to create or update.
- options: SynonymMapsCreateOrUpdateOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SynonymMap>
  
  The callback
Returns void

deleteMethod

deleteMethod(synonymMapName: string, options?: Models.SynonymMapsDeleteMethodOptionalParams): Promise<coreHttp.RestResponse>
deleteMethod(synonymMapName: string, callback: coreHttp.ServiceCallback<void>): void
deleteMethod(synonymMapName: string, options: SynonymMapsDeleteMethodOptionalParams, callback: coreHttp.ServiceCallback<void>): void

- Defined in generated/service/operations/synonymMaps.ts:67
Deletes a synonym map.

Parameters
- synonymMapName: string
  
  The name of the synonym map to delete.
- Optional options: Models.SynonymMapsDeleteMethodOptionalParams
Returns Promise<coreHttp.RestResponse>

Promise<coreHttp.RestResponse>
- Defined in generated/service/operations/synonymMaps.ts:72
Parameters
- synonymMapName: string
  
  The name of the synonym map to delete.
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void
- Defined in generated/service/operations/synonymMaps.ts:78
Parameters
- synonymMapName: string
  
  The name of the synonym map to delete.
- options: SynonymMapsDeleteMethodOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<void>
  
  The callback
Returns void

get

get(synonymMapName: string, options?: coreHttp.RequestOptionsBase): Promise<Models.SynonymMapsGetResponse>
get(synonymMapName: string, callback: coreHttp.ServiceCallback<SynonymMap>): void
get(synonymMapName: string, options: coreHttp.RequestOptionsBase, callback: coreHttp.ServiceCallback<SynonymMap>): void

- Defined in generated/service/operations/synonymMaps.ts:95
Retrieves a synonym map definition.

Parameters
- synonymMapName: string
  
  The name of the synonym map to retrieve.
- Optional options: coreHttp.RequestOptionsBase
Returns Promise<Models.SynonymMapsGetResponse>

Promise<Models.SynonymMapsGetResponse>
- Defined in generated/service/operations/synonymMaps.ts:100
Parameters
- synonymMapName: string
  
  The name of the synonym map to retrieve.
- callback: coreHttp.ServiceCallback<SynonymMap>
  
  The callback
Returns void
- Defined in generated/service/operations/synonymMaps.ts:106
Parameters
- synonymMapName: string
  
  The name of the synonym map to retrieve.
- options: coreHttp.RequestOptionsBase
  
  The optional parameters
- callback: coreHttp.ServiceCallback<SynonymMap>
  
  The callback
Returns void

list

list(options?: Models.SynonymMapsListOptionalParams): Promise<Models.SynonymMapsListResponse>
list(callback: coreHttp.ServiceCallback<ListSynonymMapsResult>): void
list(options: SynonymMapsListOptionalParams, callback: coreHttp.ServiceCallback<ListSynonymMapsResult>): void

- Defined in generated/service/operations/synonymMaps.ts:122
Lists all synonym maps available for a search service.

Parameters
- Optional options: Models.SynonymMapsListOptionalParams
Returns Promise<Models.SynonymMapsListResponse>

Promise<Models.SynonymMapsListResponse>
- Defined in generated/service/operations/synonymMaps.ts:126
Parameters
- callback: coreHttp.ServiceCallback<ListSynonymMapsResult>
  
  The callback
Returns void
- Defined in generated/service/operations/synonymMaps.ts:131
Parameters
- options: SynonymMapsListOptionalParams
  
  The optional parameters
- callback: coreHttp.ServiceCallback<ListSynonymMapsResult>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: SearchServiceClientContext

Returns SynonymMaps

Methods

create

Parameters

synonymMap: SynonymMap

Optional options: coreHttp.RequestOptionsBase

Returns Promise<Models.SynonymMapsCreateResponse>

Parameters

synonymMap: SynonymMap

callback: coreHttp.ServiceCallback<SynonymMap>

Returns void

Parameters

synonymMap: SynonymMap

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<SynonymMap>

Returns void

createOrUpdate

Parameters

synonymMapName: string

synonymMap: SynonymMap

Optional options: Models.SynonymMapsCreateOrUpdateOptionalParams

Returns Promise<Models.SynonymMapsCreateOrUpdateResponse>

Parameters

synonymMapName: string

synonymMap: SynonymMap

callback: coreHttp.ServiceCallback<SynonymMap>

Returns void

Parameters

synonymMapName: string

synonymMap: SynonymMap

options: SynonymMapsCreateOrUpdateOptionalParams

callback: coreHttp.ServiceCallback<SynonymMap>

Returns void

deleteMethod

Parameters

synonymMapName: string

Optional options: Models.SynonymMapsDeleteMethodOptionalParams

Returns Promise<coreHttp.RestResponse>

Parameters

synonymMapName: string

callback: coreHttp.ServiceCallback<void>

Returns void

Parameters

synonymMapName: string

options: SynonymMapsDeleteMethodOptionalParams

callback: coreHttp.ServiceCallback<void>

Returns void

get

Parameters

synonymMapName: string

Optional options: coreHttp.RequestOptionsBase

Returns Promise<Models.SynonymMapsGetResponse>

Parameters

synonymMapName: string

callback: coreHttp.ServiceCallback<SynonymMap>

Returns void

Parameters

synonymMapName: string

options: coreHttp.RequestOptionsBase

callback: coreHttp.ServiceCallback<SynonymMap>

Returns void

list

Parameters

Optional options: Models.SynonymMapsListOptionalParams

Returns Promise<Models.SynonymMapsListResponse>

Parameters

callback: coreHttp.ServiceCallback<ListSynonymMapsResult>

Returns void

Parameters

options: SynonymMapsListOptionalParams

callback: coreHttp.ServiceCallback<ListSynonymMapsResult>

Returns void