tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > ClassificationService > getKeywordSuggestions

ClassificationService.getKeywordSuggestions() method

Get suggestions for classifying an item with concepts from an external taxonomy. Suggestions are based on the content and metadata of the source item. This operation returns an instance of ‘KeywordSuggestions’ type.

Signature:

static getKeywordSuggestions({ sourceObject, categoryId, }: {
        sourceObject: IdentifiableObject;
        categoryId?: string;
    }): CancelablePromise<Record<string, Array<KeywordSuggestion>>>;

Parameters

Parameter	Type	Description
{ sourceObject, categoryId, }	{ sourceObject: IdentifiableObject; categoryId?: string; }

Returns:

CancelablePromise<Record<string, Array<KeywordSuggestion>>>

KeywordSuggestion The request was successful.

Exceptions

ApiError