Interface IGeocoderService

Use Geocoder

Namespace: Textkernel.Tx.Services

Assembly: Textkernel.Tx.SDK.dll

Syntax

public interface IGeocoderService

Methods

Geocode(ParsedJob, Address, GeocodeCredentials)

Use this if you would like to provide an address for geocoding instead of using the one in the parsed job. The address included in the parsed job (if present) will not be modified.

Declaration

Task<GeocodeJobResponse> Geocode(ParsedJob job, Address address, GeocodeCredentials geocodeCredentials = null)

Parameters

Type	Name	Description
ParsedJob	job	The job to insert the geocoordinates (from the address) into
Address	address	The address to use to retrieve geocoordinates
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

Geocode(ParsedJob, GeocodeCredentials)

Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.

Declaration

Task<GeocodeJobResponse> Geocode(ParsedJob job, GeocodeCredentials geocodeCredentials = null)

Parameters

Type	Name	Description
ParsedJob	job	The job to geocode
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

Geocode(ParsedResume, Address, GeocodeCredentials)

Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.

Declaration

Task<GeocodeResumeResponse> Geocode(ParsedResume resume, Address address, GeocodeCredentials geocodeCredentials = null)

Parameters

Type	Name	Description
ParsedResume	resume	The resume to insert the geocoordinates (from the address) into
Address	address	The address to use to retrieve geocoordinates
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

Geocode(ParsedResume, GeocodeCredentials)

Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.

Declaration

Task<GeocodeResumeResponse> Geocode(ParsedResume resume, GeocodeCredentials geocodeCredentials = null)

Parameters

Type	Name	Description
ParsedResume	resume	The resume to geocode
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedJob, IndexingOptionsGeneric, Address, GeocodeCredentials, Boolean)

Use this if you would like to provide an address for geocoding instead of using the one in the parsed job. The address included in the parsed job (if present) will not be modified.

Declaration

Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedJob	job	The job to insert the geocoordinates (from the address) into
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
Address	address	The address to use to retrieve geocoordinates
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedJob, IndexingOptionsGeneric, GeocodeCredentials, Boolean)

Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. These coordinates are used by the AI Searching/Matching engine.

Declaration

Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedJob	job	The job to geocode
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedJob, IndexingOptionsGeneric, GeoCoordinates, Address, GeocodeCredentials, Boolean)

Use this if you already have latitude/longitude coordinates AND a known address and want to add/override them in your parsed job. The coordinates will be inserted into your parsed job, and the address in the parsed job will not be set/modified with what you specify.

Declaration

Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, GeoCoordinates coordinates, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedJob	job	The job to insert the geocoordinates into
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
GeoCoordinates	coordinates	The geocoordinates to use
Address	address	The address to set/override in the parsed job prior to indexing
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedJob, IndexingOptionsGeneric, GeoCoordinates, GeocodeCredentials, Boolean)

Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. The coordinates will be inserted into your parsed job, and the address included in the parsed job (if present) will not be modified.

Declaration

Task<GeocodeAndIndexJobResponse> GeocodeAndIndex(ParsedJob job, IndexingOptionsGeneric indexingOptions, GeoCoordinates coordinates, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedJob	job	The job to insert the geocoordinates into
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
GeoCoordinates	coordinates	The geocoordinates to use
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexJobResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedResume, IndexingOptionsGeneric, Address, GeocodeCredentials, Boolean)

Use this if you would like to provide an address for geocoding instead of using the one in the parsed resume. The address included in the parsed resume (if present) will not be modified.

Declaration

Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedResume	resume	The resume to insert the geocoordinates (from the address) into
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
Address	address	The address to use to retrieve geocoordinates
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedResume, IndexingOptionsGeneric, GeocodeCredentials, Boolean)

Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. These coordinates are used by the AI Searching/Matching engine.

Declaration

Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedResume	resume	The resume to geocode
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedResume, IndexingOptionsGeneric, GeoCoordinates, Address, GeocodeCredentials, Boolean)

Use this if you already have latitude/longitude coordinates AND a known address and want to add/override them in your parsed resume. The coordinates will be inserted into your parsed resume, and the address in the parsed resume will not be set/modified with what you specify.

Declaration

Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, GeoCoordinates coordinates, Address address, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedResume	resume	The resume to insert the geocoordinates into
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
GeoCoordinates	coordinates	The geocoordinates to use
Address	address	The address to set/override in the parsed resume prior to indexing
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred

GeocodeAndIndex(ParsedResume, IndexingOptionsGeneric, GeoCoordinates, GeocodeCredentials, Boolean)

Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. The coordinates will be inserted into your parsed resume, and the address included in the parsed resume (if present) will not be modified.

Declaration

Task<GeocodeAndIndexResumeResponse> GeocodeAndIndex(ParsedResume resume, IndexingOptionsGeneric indexingOptions, GeoCoordinates coordinates, GeocodeCredentials geocodeCredentials = null, bool indexIfGeocodeFails = false)

Parameters

Type	Name	Description
ParsedResume	resume	The resume to insert the geocoordinates into
IndexingOptionsGeneric	indexingOptions	What index/document id to use to index the document after geocoding
GeoCoordinates	coordinates	The geocoordinates to use
GeocodeCredentials	geocodeCredentials	The credentials used for geocoding
System.Boolean	indexIfGeocodeFails	Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Type	Description
System.Threading.Tasks.Task<GeocodeAndIndexResumeResponse>

Exceptions

Type	Condition
TxException	Thrown when an API error occurred