Skip to content

Correctly add terms to posts generated by Watson content classifiers #462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dkotter merged 13 commits into from
May 26, 2023
Merged

Correctly add terms to posts generated by Watson content classifiers #462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
91acf74
add: update logic to attach terms correctely to post
ravinderk May 23, 2023
ef8f457
format: add missing semicolon
ravinderk May 23, 2023
71eaad9
refactor: make function accessable public
ravinderk May 23, 2023
cb35c80
fix: remove unnecessary type conversion
ravinderk May 23, 2023
de19c57
fix: allow to set or get terms from functions
ravinderk May 23, 2023
df15edb
refactor: do not use intval
ravinderk May 23, 2023
28ecf0f
refactor: get terms only if relative watson data exist
ravinderk May 23, 2023
8178b94
format: improve code formatting
ravinderk May 25, 2023
f8467bb
refactor: update logic to whther link terms instead of return result.
ravinderk May 25, 2023
2e467ea
add: return terms with taxonomy
ravinderk May 25, 2023
4ec6c7e
tests: fix broken tests
ravinderk May 25, 2023
83daef4
tests: remove unused param
ravinderk May 25, 2023
5b34d69
refactor: link terms by default
ravinderk May 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 106 additions & 46 deletions includes/Classifai/Watson/Linker.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,25 +33,39 @@ class Linker {
* @param int $post_id The post to link to.
* @param array $output The classification results from Watson NLU.
* @param array $options Unused.

* @return void
*
* @return array The terms that were linked.
*/
public function link( $post_id, $output, $options = [] ) {
$all_terms = [];

if ( ! empty( $output['categories'] ) ) {
$this->link_categories( $post_id, $output['categories'] );
$terms = $this->link_categories( $post_id, $output['categories'], false );
$all_terms = $terms;
}

if ( ! empty( $output['keywords'] ) ) {
$this->link_keywords( $post_id, $output['keywords'] );
$terms = $this->link_keywords( $post_id, $output['keywords'], false );
$all_terms = array_merge_recursive( $all_terms, $terms );
}

if ( ! empty( $output['concepts'] ) ) {
$this->link_concepts( $post_id, $output['concepts'] );
$terms = $this->link_concepts( $post_id, $output['concepts'], false );
$all_terms = array_merge_recursive( $all_terms, $terms );
}

if ( ! empty( $output['entities'] ) ) {
$this->link_entities( $post_id, $output['entities'] );
$terms = $this->link_entities( $post_id, $output['entities'], false );
$all_terms = array_merge_recursive( $all_terms, $terms );
}

if ( ! empty( $all_terms ) ) {
foreach ( $all_terms as $taxonomy => $terms ) {
wp_set_object_terms( $post_id, $terms, $taxonomy, false );
}
}

return $all_terms;
}

/* helpers */
Expand All @@ -71,11 +85,13 @@ public function link( $post_id, $output, $options = [] ) {
*
* Eg:- /animals/pets/cats
*
* @param int $post_id The id of the post to link
* @param int $post_id The id of the post to link.
* @param array $categories The list of categories to link
* @return void
Comment thread
ravinderk marked this conversation as resolved.
* @param bool $link_categories Whether link categories to post or return array of term ids.
*
* @return array|\WP_Error List of the terms to link. WP_Error class object on error.
*/
public function link_categories( $post_id, $categories ) {
public function link_categories( int $post_id, array $categories, bool $link_categories = true ) {
$terms_to_link = [];
$taxonomy = \Classifai\get_feature_taxonomy( 'category' );

Expand All @@ -91,30 +107,35 @@ public function link_categories( $post_id, $categories ) {
$term = get_term_by( 'name', $part, $taxonomy );

if ( false === $term ) {
$term = wp_insert_term(
$part,
$taxonomy,
[
'parent' => $parent,
]
);
$term = wp_insert_term( $part, $taxonomy, [ 'parent' => $parent ] );

if ( ! is_wp_error( $term ) ) {
$parent = intval( $term['term_id'] );
$terms_to_link[] = intval( $term['term_id'] );
$parent = (int) $term['term_id'];
$terms_to_link[] = (int) $term['term_id'];
}
} else {
$parent = intval( $term->term_id );
$terms_to_link[] = intval( $term->term_id );
$parent = $term->term_id;
$terms_to_link[] = $term->term_id;
}
}
}
}
}

if ( ! empty( $terms_to_link ) ) {
wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );
// Exit if there are not any term to link.
if ( empty( $terms_to_link ) ) {
return [];
}

if ( $link_categories ) {
$result = wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );

if ( is_wp_error( $result ) ) {
return $result;
}
}

return [ $taxonomy => $terms_to_link ];
}

/**
Expand All @@ -127,11 +148,13 @@ public function link_categories( $post_id, $categories ) {
* ...
* ]
*
* @param int $post_id The post to link to
* @param int $post_id The id of the post to link.
* @param array $keywords NLU returned keywords
* @return void
* @param bool $link_keywords Whether link keywords to post or return array of term ids.
*
* @return array|\WP_Error List of the terms to link. WP_Error class object on error.
*/
public function link_keywords( $post_id, $keywords ) {
public function link_keywords( int $post_id, array $keywords, bool $link_keywords = true ) {
$terms_to_link = [];
$taxonomy = \Classifai\get_feature_taxonomy( 'keyword' );

Expand All @@ -145,17 +168,28 @@ public function link_keywords( $post_id, $keywords ) {
$term = wp_insert_term( $name, $taxonomy, [] );

if ( ! is_wp_error( $term ) ) {
$terms_to_link[] = intval( $term['term_id'] );
$terms_to_link[] = (int) $term['term_id'];
}
} else {
$terms_to_link[] = intval( $term->term_id );
$terms_to_link[] = $term->term_id;
}
}
}

if ( ! empty( $terms_to_link ) ) {
wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );
// Exit if there are not any term to link.
if ( empty( $terms_to_link ) ) {
return [];
}

if ( $link_keywords ) {
$result = wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );

if ( is_wp_error( $result ) ) {
return $result;
}
}

return [ $taxonomy => $terms_to_link ];
}

/**
Expand All @@ -168,11 +202,13 @@ public function link_keywords( $post_id, $keywords ) {
* ...
* ]
*
* @param int $post_id The post to link to.
* @param int $post_id The id of the post to link.
* @param array $concepts The NLU returned concepts.
* @return void
* @param bool $link_concepts Whether link concepts to post or return array of term ids.
*
* @return array|\WP_Error List of the terms to link. WP_Error class object on error.
*/
public function link_concepts( $post_id, $concepts ) {
public function link_concepts( int $post_id, array $concepts, bool $link_concepts = true ) {
$terms_to_link = [];
$taxonomy = \Classifai\get_feature_taxonomy( 'concept' );

Expand All @@ -185,25 +221,36 @@ public function link_concepts( $post_id, $concepts ) {
$term = wp_insert_term( $name, $taxonomy, [] );

if ( ! is_wp_error( $term ) ) {
$terms_to_link[] = intval( $term['term_id'] );
$terms_to_link[] = (int) $term['term_id'];

if ( ! empty( $concept['dbpedia_resource'] ) ) {
update_term_meta(
intval( $term['term_id'] ),
(int) $term['term_id'],
'dbpedia_resource',
$concept['dbpedia_resource']
);
}
}
} else {
$terms_to_link[] = intval( $term->term_id );
$terms_to_link[] = $term->term_id;
}
}
}

if ( ! empty( $terms_to_link ) ) {
wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );
// Exit if there are not any term to link.
if ( empty( $terms_to_link ) ) {
return [];
}

if ( $link_concepts ) {
$result = wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );

if ( is_wp_error( $result ) ) {
return $result;
}
}

return [ $taxonomy => $terms_to_link ];
}

/**
Expand All @@ -216,11 +263,13 @@ public function link_concepts( $post_id, $concepts ) {
* ...
* ]
*
* @param int $post_id The post to link to
* @param int $post_id The id of the post to link.
* @param array $entities The entities returned by the NLU api
* @return void
* @param bool $link_entities Whether link entities to post or return array of term ids.
*
* @return array|\WP_Error List of the terms to link. WP_Error class object on error.
*/
public function link_entities( $post_id, $entities ) {
public function link_entities( int $post_id, array $entities, bool $link_entities = true ) {
$terms_to_link = [];
$taxonomy = \Classifai\get_feature_taxonomy( 'entity' );

Expand All @@ -238,31 +287,42 @@ public function link_entities( $post_id, $entities ) {
$term = wp_insert_term( $name, $taxonomy, [] );

if ( ! is_wp_error( $term ) ) {
$terms_to_link[] = intval( $term['term_id'] );
$terms_to_link[] = (int) $term['term_id'];

if ( ! empty( $entity['disambiguation']['dbpedia_resource'] ) ) {
update_term_meta(
intval( $term['term_id'] ),
(int) $term['term_id'],
'dbpedia_resource',
$entity['disambiguation']['dbpedia_resource']
);

update_term_meta(
intval( $term['term_id'] ),
(int) $term['term_id'],
'type',
$entity['type']
);
}
}
} else {
$terms_to_link[] = intval( $term->term_id );
$terms_to_link[] = $term->term_id;
}
}
}

if ( ! empty( $terms_to_link ) ) {
wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );
// Exit if there are not any term to link.
if ( empty( $terms_to_link ) ) {
return [];
}

if ( $link_entities ) {
$result = wp_set_object_terms( $post_id, $terms_to_link, $taxonomy, false );

if ( is_wp_error( $result ) ) {
return $result;
}
}

return [ $taxonomy => $terms_to_link ];
}

/**
Expand Down
1 change: 1 addition & 0 deletions tests/Classifai/PostClassifierTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

class PostClassifierTest extends \WP_UnitTestCase {

/* @var PostClassifier $classifier */
public $classifier;

function set_up() {
Expand Down
1 change: 1 addition & 0 deletions tests/Classifai/Watson/LinkerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

class LinkerTest extends \WP_UnitTestCase {

/* @var Linker $linker */
public $linker;

function set_up() {
Expand Down