Interface IGeocoderService

Namespace

Textkernel.Tx.Services

Assembly

Textkernel.Tx.SDK.dll

Use Geocoder

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.

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

Parameters

job ParsedJob

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

Task<GeocodeJobResponse>

Exceptions

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.

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

Parameters

job ParsedJob

The job to geocode

geocodeCredentials GeocodeCredentials

The credentials used for geocoding

Returns

Task<GeocodeJobResponse>

Exceptions

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.

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

Parameters

resume ParsedResume

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

Task<GeocodeResumeResponse>

Exceptions

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.

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

Parameters

resume ParsedResume

The resume to geocode

geocodeCredentials GeocodeCredentials

The credentials used for geocoding

Returns

Task<GeocodeResumeResponse>

Exceptions

TxException

Thrown when an API error occurred

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

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.

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

Parameters

job ParsedJob

The job to insert the geocoordinates (from the address) into

indexingOptions IndexingOptionsGeneric

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

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexJobResponse>

Exceptions

TxException

Thrown when an API error occurred

GeocodeAndIndex(ParsedJob, IndexingOptionsGeneric, GeocodeCredentials, bool)

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.

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

Parameters

job ParsedJob

The job to geocode

indexingOptions IndexingOptionsGeneric

What index/document id to use to index the document after geocoding

geocodeCredentials GeocodeCredentials

The credentials used for geocoding

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexJobResponse>

Exceptions

TxException

Thrown when an API error occurred

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

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.

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

Parameters

job ParsedJob

The job to insert the geocoordinates into

indexingOptions IndexingOptionsGeneric

What index/document id to use to index the document after geocoding

coordinates GeoCoordinates

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

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexJobResponse>

Exceptions

TxException

Thrown when an API error occurred

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

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.

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

Parameters

job ParsedJob

The job to insert the geocoordinates into

indexingOptions IndexingOptionsGeneric

What index/document id to use to index the document after geocoding

coordinates GeoCoordinates

The geocoordinates to use

geocodeCredentials GeocodeCredentials

The credentials used for geocoding

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexJobResponse>

Exceptions

TxException

Thrown when an API error occurred

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

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.

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

Parameters

resume ParsedResume

The resume to insert the geocoordinates (from the address) into

indexingOptions IndexingOptionsGeneric

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

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexResumeResponse>

Exceptions

TxException

Thrown when an API error occurred

GeocodeAndIndex(ParsedResume, IndexingOptionsGeneric, GeocodeCredentials, bool)

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.

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

Parameters

resume ParsedResume

The resume to geocode

indexingOptions IndexingOptionsGeneric

What index/document id to use to index the document after geocoding

geocodeCredentials GeocodeCredentials

The credentials used for geocoding

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexResumeResponse>

Exceptions

TxException

Thrown when an API error occurred

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

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.

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

Parameters

resume ParsedResume

The resume to insert the geocoordinates into

indexingOptions IndexingOptionsGeneric

What index/document id to use to index the document after geocoding

coordinates GeoCoordinates

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

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexResumeResponse>

Exceptions

TxException

Thrown when an API error occurred

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

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.

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

Parameters

resume ParsedResume

The resume to insert the geocoordinates into

indexingOptions IndexingOptionsGeneric

What index/document id to use to index the document after geocoding

coordinates GeoCoordinates

The geocoordinates to use

geocodeCredentials GeocodeCredentials

The credentials used for geocoding

indexIfGeocodeFails bool

Indicates whether or not the document should still be added to the index if the geocode request fails. Default is false.

Returns

Task<GeocodeAndIndexResumeResponse>

Exceptions

TxException

Thrown when an API error occurred