> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # genesys-knowledge > Genesys Knowledge - knowledge base lifecycle, documents, categories, labels, search, answers, feedback, and integrations **Server path:** `/genesys-knowledge` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | [`genesys_knowledge_delete_knowledgebase`](#genesys_knowledge_delete_knowledgebase) | Delete knowledge base | | [`genesys_knowledge_delete_knowledgebase_category`](#genesys_knowledge_delete_knowledgebase_category) | Delete category | | [`genesys_knowledge_delete_knowledgebase_document`](#genesys_knowledge_delete_knowledgebase_document) | Delete document. | | [`genesys_knowledge_delete_knowledgebase_document_variation`](#genesys_knowledge_delete_knowledgebase_document_variation) | Delete a variation for a document. | | [`genesys_knowledge_delete_knowledgebase_label`](#genesys_knowledge_delete_knowledgebase_label) | Delete label | | [`genesys_knowledge_delete_knowledgebase_sources_salesforce_source_id`](#genesys_knowledge_delete_knowledgebase_sources_salesforce_source_id) | Delete Salesforce Knowledge integration source | | [`genesys_knowledge_delete_knowledgebase_sources_servicenow_source_id`](#genesys_knowledge_delete_knowledgebase_sources_servicenow_source_id) | Delete ServiceNow Knowledge integration source | | [`genesys_knowledge_delete_knowledgebase_synchronize_job`](#genesys_knowledge_delete_knowledgebase_synchronize_job) | Delete synchronization job | | [`genesys_knowledge_delete_setting`](#genesys_knowledge_delete_setting) | Delete Knowledge setting. | | [`genesys_knowledge_get_guest_session_categories`](#genesys_knowledge_get_guest_session_categories) | Get categories | | [`genesys_knowledge_get_guest_session_document`](#genesys_knowledge_get_guest_session_document) | Get a knowledge document by ID. | | [`genesys_knowledge_get_guest_session_documents`](#genesys_knowledge_get_guest_session_documents) | Get documents. | | [`genesys_knowledge_get_integration_options`](#genesys_knowledge_get_integration_options) | Get sync options available for a knowledge-connect integration | | [`genesys_knowledge_get_knowledge_knowledgebase`](#genesys_knowledge_get_knowledge_knowledgebase) | Get knowledge base | | [`genesys_knowledge_get_knowledge_knowledgebase_categories`](#genesys_knowledge_get_knowledge_knowledgebase_categories) | Get categories | | [`genesys_knowledge_get_knowledge_knowledgebase_category`](#genesys_knowledge_get_knowledge_knowledgebase_category) | Get category | | [`genesys_knowledge_get_knowledge_knowledgebase_document`](#genesys_knowledge_get_knowledge_knowledgebase_document) | Get document. | | [`genesys_knowledge_get_knowledge_knowledgebase_document_variations`](#genesys_knowledge_get_knowledge_knowledgebase_document_variations) | Get variations for a document. | | [`genesys_knowledge_get_knowledge_knowledgebase_documents`](#genesys_knowledge_get_knowledge_knowledgebase_documents) | Get documents. | | [`genesys_knowledge_get_knowledge_knowledgebase_labels`](#genesys_knowledge_get_knowledge_knowledgebase_labels) | Get labels | | [`genesys_knowledge_get_knowledge_knowledgebases`](#genesys_knowledge_get_knowledge_knowledgebases) | Get knowledge bases | | [`genesys_knowledge_get_knowledgebase`](#genesys_knowledge_get_knowledgebase) | Get knowledge base | | [`genesys_knowledge_get_knowledgebase_categories`](#genesys_knowledge_get_knowledgebase_categories) | Get categories | | [`genesys_knowledge_get_knowledgebase_category`](#genesys_knowledge_get_knowledgebase_category) | Get category | | [`genesys_knowledge_get_knowledgebase_document`](#genesys_knowledge_get_knowledgebase_document) | Get document. | | [`genesys_knowledge_get_knowledgebase_document_feedback`](#genesys_knowledge_get_knowledgebase_document_feedback) | Get a list of feedback records given on a document | | [`genesys_knowledge_get_knowledgebase_document_feedback_feedback_id`](#genesys_knowledge_get_knowledgebase_document_feedback_feedback_id) | Get a single feedback record given on a document | | [`genesys_knowledge_get_knowledgebase_document_variation`](#genesys_knowledge_get_knowledgebase_document_variation) | Get a variation for a document. | | [`genesys_knowledge_get_knowledgebase_document_variations`](#genesys_knowledge_get_knowledgebase_document_variations) | Get variations for a document. | | [`genesys_knowledge_get_knowledgebase_document_version`](#genesys_knowledge_get_knowledgebase_document_version) | Get document version. | | [`genesys_knowledge_get_knowledgebase_document_version_variation`](#genesys_knowledge_get_knowledgebase_document_version_variation) | Get variation for the given document version. | | [`genesys_knowledge_get_knowledgebase_document_version_variations`](#genesys_knowledge_get_knowledgebase_document_version_variations) | Get variations for the given document version. | | [`genesys_knowledge_get_knowledgebase_document_versions`](#genesys_knowledge_get_knowledgebase_document_versions) | Get document versions. | | [`genesys_knowledge_get_knowledgebase_documents`](#genesys_knowledge_get_knowledgebase_documents) | Get documents. | | [`genesys_knowledge_get_knowledgebase_label`](#genesys_knowledge_get_knowledgebase_label) | Get label | | [`genesys_knowledge_get_knowledgebase_labels`](#genesys_knowledge_get_knowledgebase_labels) | Get labels | | [`genesys_knowledge_get_knowledgebase_operations`](#genesys_knowledge_get_knowledgebase_operations) | Get operations | | [`genesys_knowledge_get_knowledgebase_operations_users_query`](#genesys_knowledge_get_knowledgebase_operations_users_query) | Get ids of operation creator users and oauth clients | | [`genesys_knowledge_get_knowledgebase_parse_job`](#genesys_knowledge_get_knowledgebase_parse_job) | Get parse job report | | [`genesys_knowledge_get_knowledgebase_sources`](#genesys_knowledge_get_knowledgebase_sources) | Get Knowledge integration sources | | [`genesys_knowledge_get_knowledgebase_sources_salesforce_source_id`](#genesys_knowledge_get_knowledgebase_sources_salesforce_source_id) | Get Salesforce Knowledge integration source | | [`genesys_knowledge_get_knowledgebase_sources_servicenow_source_id`](#genesys_knowledge_get_knowledgebase_sources_servicenow_source_id) | Get ServiceNow Knowledge integration source | | [`genesys_knowledge_get_knowledgebase_synchronize_job`](#genesys_knowledge_get_knowledgebase_synchronize_job) | Get synchronization job report | | [`genesys_knowledge_get_knowledgebase_unanswered_group`](#genesys_knowledge_get_knowledgebase_unanswered_group) | Get knowledge base unanswered group for a particular groupId | | [`genesys_knowledge_get_knowledgebase_unanswered_group_phrasegroup`](#genesys_knowledge_get_knowledgebase_unanswered_group_phrasegroup) | Get knowledge base unanswered phrase group for a particular phraseGroupId | | [`genesys_knowledge_get_knowledgebase_unanswered_groups`](#genesys_knowledge_get_knowledgebase_unanswered_groups) | Get knowledge base unanswered groups | | [`genesys_knowledge_get_knowledgebase_uploads_urls_job`](#genesys_knowledge_get_knowledgebase_uploads_urls_job) | Get content upload from URL job status | | [`genesys_knowledge_get_knowledgebases`](#genesys_knowledge_get_knowledgebases) | Get knowledge bases | | [`genesys_knowledge_get_setting`](#genesys_knowledge_get_setting) | Get Knowledge setting. | | [`genesys_knowledge_get_settings`](#genesys_knowledge_get_settings) | Get Knowledge settings. | | [`genesys_knowledge_patch_guest_session_documents_search_search_id`](#genesys_knowledge_patch_guest_session_documents_search_search_id) | Update search result. | | [`genesys_knowledge_patch_knowledgebase`](#genesys_knowledge_patch_knowledgebase) | Update knowledge base | | [`genesys_knowledge_patch_knowledgebase_category`](#genesys_knowledge_patch_knowledgebase_category) | Update category | | [`genesys_knowledge_patch_knowledgebase_chunks_search_search_id`](#genesys_knowledge_patch_knowledgebase_chunks_search_search_id) | Register chunk search result. | | [`genesys_knowledge_patch_knowledgebase_document`](#genesys_knowledge_patch_knowledgebase_document) | Update document. | | [`genesys_knowledge_patch_knowledgebase_document_feedback_feedback_id`](#genesys_knowledge_patch_knowledgebase_document_feedback_feedback_id) | Update feedback on a document | | [`genesys_knowledge_patch_knowledgebase_document_variation`](#genesys_knowledge_patch_knowledgebase_document_variation) | Update a variation for a document. | | [`genesys_knowledge_patch_knowledgebase_documents_search_search_id`](#genesys_knowledge_patch_knowledgebase_documents_search_search_id) | Update search result. | | [`genesys_knowledge_patch_knowledgebase_label`](#genesys_knowledge_patch_knowledgebase_label) | Update label | | [`genesys_knowledge_patch_knowledgebase_parse_job`](#genesys_knowledge_patch_knowledgebase_parse_job) | Send update to the parse operation | | [`genesys_knowledge_patch_knowledgebase_synchronize_job`](#genesys_knowledge_patch_knowledgebase_synchronize_job) | Update synchronization job | | [`genesys_knowledge_patch_knowledgebase_unanswered_group_phrasegroup`](#genesys_knowledge_patch_knowledgebase_unanswered_group_phrasegroup) | Update a Knowledge base unanswered phrase group | | [`genesys_knowledge_patch_setting`](#genesys_knowledge_patch_setting) | Update Knowledge setting. | | [`genesys_knowledge_post_documentuploads`](#genesys_knowledge_post_documentuploads) | Creates a presigned URL for uploading a knowledge import file with a set of documents | | [`genesys_knowledge_post_guest_session_document_copies`](#genesys_knowledge_post_guest_session_document_copies) | Indicate that the document was copied by the user. | | [`genesys_knowledge_post_guest_session_document_feedback`](#genesys_knowledge_post_guest_session_document_feedback) | Give feedback on a document | | [`genesys_knowledge_post_guest_session_document_views`](#genesys_knowledge_post_guest_session_document_views) | Create view event for a document. | | [`genesys_knowledge_post_guest_session_documents_answers`](#genesys_knowledge_post_guest_session_documents_answers) | Answer documents. | | [`genesys_knowledge_post_guest_session_documents_presentations`](#genesys_knowledge_post_guest_session_documents_presentations) | Indicate that documents were presented to the user. | | [`genesys_knowledge_post_guest_session_documents_search`](#genesys_knowledge_post_guest_session_documents_search) | Search the documents in a guest session. | | [`genesys_knowledge_post_guest_session_documents_search_suggestions`](#genesys_knowledge_post_guest_session_documents_search_suggestions) | Query the knowledge documents to provide suggestions for auto completion. | | [`genesys_knowledge_post_guest_sessions`](#genesys_knowledge_post_guest_sessions) | Create guest session | | [`genesys_knowledge_post_knowledge_knowledgebase_documents_query`](#genesys_knowledge_post_knowledge_knowledgebase_documents_query) | Query for knowledge documents. | | [`genesys_knowledge_post_knowledge_knowledgebase_documents_search`](#genesys_knowledge_post_knowledge_knowledgebase_documents_search) | Search the documents in a knowledge base. | | [`genesys_knowledge_post_knowledge_knowledgebase_documents_search_suggestions`](#genesys_knowledge_post_knowledge_knowledgebase_documents_search_suggestions) | Query the knowledge documents to provide suggestions for auto completion. | | [`genesys_knowledge_post_knowledge_search`](#genesys_knowledge_post_knowledge_search) | Get Knowledge Search | | [`genesys_knowledge_post_knowledgebase_categories`](#genesys_knowledge_post_knowledgebase_categories) | Create new category | | [`genesys_knowledge_post_knowledgebase_chunks_search`](#genesys_knowledge_post_knowledgebase_chunks_search) | Search for chunks in a knowledge base | | [`genesys_knowledge_post_knowledgebase_document_copies`](#genesys_knowledge_post_knowledgebase_document_copies) | Indicate that the document was copied by the user. | | [`genesys_knowledge_post_knowledgebase_document_feedback`](#genesys_knowledge_post_knowledgebase_document_feedback) | Give feedback on a document | | [`genesys_knowledge_post_knowledgebase_document_variations`](#genesys_knowledge_post_knowledgebase_document_variations) | Create a variation for a document. | | [`genesys_knowledge_post_knowledgebase_document_versions`](#genesys_knowledge_post_knowledgebase_document_versions) | Creates or restores a document version. | | [`genesys_knowledge_post_knowledgebase_document_views`](#genesys_knowledge_post_knowledgebase_document_views) | Create view for a document. | | [`genesys_knowledge_post_knowledgebase_documents`](#genesys_knowledge_post_knowledgebase_documents) | Create document. | | [`genesys_knowledge_post_knowledgebase_documents_answers`](#genesys_knowledge_post_knowledgebase_documents_answers) | Answer documents. | | [`genesys_knowledge_post_knowledgebase_documents_presentations`](#genesys_knowledge_post_knowledgebase_documents_presentations) | Indicate that documents were presented to the user. | | [`genesys_knowledge_post_knowledgebase_documents_query`](#genesys_knowledge_post_knowledgebase_documents_query) | Query for knowledge documents. | | [`genesys_knowledge_post_knowledgebase_documents_search`](#genesys_knowledge_post_knowledgebase_documents_search) | Search the documents in a knowledge base. | | [`genesys_knowledge_post_knowledgebase_documents_search_suggestions`](#genesys_knowledge_post_knowledgebase_documents_search_suggestions) | Query the knowledge documents to provide suggestions for auto completion. | | [`genesys_knowledge_post_knowledgebase_labels`](#genesys_knowledge_post_knowledgebase_labels) | Create new label | | [`genesys_knowledge_post_knowledgebase_parse_jobs`](#genesys_knowledge_post_knowledgebase_parse_jobs) | Create parse job | | [`genesys_knowledge_post_knowledgebase_sources_salesforce`](#genesys_knowledge_post_knowledgebase_sources_salesforce) | Create Salesforce Knowledge integration source | | [`genesys_knowledge_post_knowledgebase_sources_salesforce_source_id_sync`](#genesys_knowledge_post_knowledgebase_sources_salesforce_source_id_sync) | Start sync on Salesforce Knowledge integration source | | [`genesys_knowledge_post_knowledgebase_sources_servicenow`](#genesys_knowledge_post_knowledgebase_sources_servicenow) | Create ServiceNow Knowledge integration source | | [`genesys_knowledge_post_knowledgebase_sources_servicenow_source_id_sync`](#genesys_knowledge_post_knowledgebase_sources_servicenow_source_id_sync) | Start synchronization on ServiceNow Knowledge integration source | | [`genesys_knowledge_post_knowledgebase_synchronize_jobs`](#genesys_knowledge_post_knowledgebase_synchronize_jobs) | Create synchronization job | | [`genesys_knowledge_post_knowledgebase_uploads_urls_jobs`](#genesys_knowledge_post_knowledgebase_uploads_urls_jobs) | Create content upload from URL job | | [`genesys_knowledge_post_knowledgebases`](#genesys_knowledge_post_knowledgebases) | Create new knowledge base | | [`genesys_knowledge_post_search`](#genesys_knowledge_post_search) | Get Knowledge Search | | [`genesys_knowledge_post_search_preview`](#genesys_knowledge_post_search_preview) | Get Knowledge Search Preview | | [`genesys_knowledge_post_settings`](#genesys_knowledge_post_settings) | Create Knowledge setting. | | [`genesys_knowledge_put_knowledgebase_sources_salesforce_source_id`](#genesys_knowledge_put_knowledgebase_sources_salesforce_source_id) | Update Salesforce Knowledge integration source | | [`genesys_knowledge_put_knowledgebase_sources_servicenow_source_id`](#genesys_knowledge_put_knowledgebase_sources_servicenow_source_id) | Update ServiceNow Knowledge integration source | *** ## genesys\_knowledge\_delete\_knowledgebase Delete knowledge base **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_category Delete category **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `categoryId` | string | Yes | — | Category ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "categoryId": { "type": "string", "description": "Category ID" } }, "required": [ "PCID", "knowledgeBaseId", "categoryId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_document Delete document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_document\_variation Delete a variation for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ---------------------------------------------------- | | `documentVariationId` | string | Yes | — | Globally unique identifier for a document variation. | | `documentId` | string | Yes | — | Globally unique identifier for a document. | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for a knowledge base. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentVariationId": { "type": "string", "description": "Globally unique identifier for a document variation." }, "documentId": { "type": "string", "description": "Globally unique identifier for a document." }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for a knowledge base." } }, "required": [ "PCID", "documentVariationId", "documentId", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_label Delete label **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `labelId` | string | Yes | — | Label ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "labelId": { "type": "string", "description": "Label ID" } }, "required": [ "PCID", "knowledgeBaseId", "labelId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_sources\_salesforce\_source\_id Delete Salesforce Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" } }, "required": [ "PCID", "knowledgeBaseId", "sourceId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_sources\_servicenow\_source\_id Delete ServiceNow Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" } }, "required": [ "PCID", "knowledgeBaseId", "sourceId" ] } ``` *** ## genesys\_knowledge\_delete\_knowledgebase\_synchronize\_job Delete synchronization job **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `syncJobId` | string | Yes | — | Synchronization job ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "syncJobId": { "type": "string", "description": "Synchronization job ID" } }, "required": [ "PCID", "knowledgeBaseId", "syncJobId" ] } ``` *** ## genesys\_knowledge\_delete\_setting Delete Knowledge setting. **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | --------------------- | | `knowledgeSettingId` | string | Yes | — | Knowledge Setting ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeSettingId": { "type": "string", "description": "Knowledge Setting ID." } }, "required": [ "PCID", "knowledgeSettingId" ] } ``` *** ## genesys\_knowledge\_get\_guest\_session\_categories Get categories **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `parentId` | string | No | — | If specified, retrieves the children categories by parent category ID. | | `isRoot` | boolean | No | — | If specified, retrieves only the root categories. | | `name` | string | No | — | Filter to return the categories that starts with the given category name. | | `sortBy` | string | No | — | Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically | | `expand` | string | No | — | The specified entity attribute will be filled. Supported value:"Ancestors": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. | | `includeDocumentCount` | boolean | No | — | If specified, retrieves the number of documents related to category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "parentId": { "type": "string", "description": "If specified, retrieves the children categories by parent category ID." }, "isRoot": { "type": "boolean", "description": "If specified, retrieves only the root categories." }, "name": { "type": "string", "description": "Filter to return the categories that starts with the given category name." }, "sortBy": { "type": "string", "description": "Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically", "enum": [ "Name", "Hierarchy" ] }, "expand": { "type": "string", "description": "The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors." }, "includeDocumentCount": { "type": "boolean", "description": "If specified, retrieves the number of documents related to category." } }, "required": [ "PCID", "sessionId" ] } ``` *** ## genesys\_knowledge\_get\_guest\_session\_document Get a knowledge document by ID. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | --------------------------- | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `documentId` | string | Yes | — | Document ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "documentId": { "type": "string", "description": "Document ID" } }, "required": [ "PCID", "sessionId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_guest\_session\_documents Get documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------ | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `categoryId` | string\[] | No | — | If specified, retrieves documents associated with category ids, comma separated values expected. | | `pageSize` | integer | No | — | Number of entities to return. Maximum of 200. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "categoryId": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves documents associated with category ids, comma separated values expected." }, "pageSize": { "type": "integer", "description": "Number of entities to return. Maximum of 200." } }, "required": [ "PCID", "sessionId" ] } ``` *** ## genesys\_knowledge\_get\_integration\_options Get sync options available for a knowledge-connect integration **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | ---------------------------------------------------------- | | `integrationId` | string | Yes | — | Integration ID | | `knowledgeBaseIds` | string\[] | No | — | Narrowing down filtering option results by knowledge base. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "integrationId": { "type": "string", "description": "Integration ID" }, "knowledgeBaseIds": { "type": "array", "items": { "type": "string" }, "description": "Narrowing down filtering option results by knowledge base." } }, "required": [ "PCID", "integrationId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase Get knowledge base **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase\_categories Get categories **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `parentId` | string | No | — | If specified, retrieves the children categories by parent category ID. | | `isRoot` | boolean | No | — | If specified, retrieves only the root categories. | | `name` | string | No | — | Filter to return the categories that starts with the given category name. | | `sortBy` | string | No | — | Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically | | `expand` | string | No | — | The specified entity attribute will be filled. Supported value:"Ancestors": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. | | `includeDocumentCount` | boolean | No | — | If specified, retrieves the number of documents related to category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "parentId": { "type": "string", "description": "If specified, retrieves the children categories by parent category ID." }, "isRoot": { "type": "boolean", "description": "If specified, retrieves only the root categories." }, "name": { "type": "string", "description": "Filter to return the categories that starts with the given category name." }, "sortBy": { "type": "string", "description": "Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically", "enum": [ "Name", "Hierarchy" ] }, "expand": { "type": "string", "description": "The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors." }, "includeDocumentCount": { "type": "boolean", "description": "If specified, retrieves the number of documents related to category." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase\_category Get category **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `categoryId` | string | Yes | — | Category ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "categoryId": { "type": "string", "description": "Category ID" } }, "required": [ "PCID", "knowledgeBaseId", "categoryId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase\_document Get document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `expand` | any\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. | | `state` | string | No | — | "when state is "Draft", draft version of the document is returned,otherwise by default published version is returned in the response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "expand": { "type": "array", "description": "The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20." }, "state": { "type": "string", "description": "\"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response.", "enum": [ "Draft", "Published" ] } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase\_document\_variations Get variations for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `documentState` | string | No | — | The state of the document. | | `expand` | any\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "documentState": { "type": "string", "description": "The state of the document.", "enum": [ "Draft", "Published" ] }, "expand": { "type": "array", "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase\_documents Get documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `interval` | string | No | — | Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ | | `documentId` | any\[] | No | — | Retrieves the specified documents, comma separated values expected. | | `categoryId` | any\[] | No | — | If specified, retrieves documents associated with category ids, comma separated values expected. | | `includeSubcategories` | boolean | No | — | Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. | | `includeDrafts` | boolean | No | — | If includeDrafts is true, Documents in the draft state are also returned in the response. | | `labelIds` | any\[] | No | — | If specified, retrieves documents associated with label ids, comma separated values expected. | | `expand` | any\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | | `externalIds` | any\[] | No | — | If specified, retrieves documents associated with external ids, comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "interval": { "type": "string", "description": "Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ" }, "documentId": { "type": "array", "description": "Retrieves the specified documents, comma separated values expected." }, "categoryId": { "type": "array", "description": "If specified, retrieves documents associated with category ids, comma separated values expected." }, "includeSubcategories": { "type": "boolean", "description": "Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories." }, "includeDrafts": { "type": "boolean", "description": "If includeDrafts is true, Documents in the draft state are also returned in the response." }, "labelIds": { "type": "array", "description": "If specified, retrieves documents associated with label ids, comma separated values expected." }, "expand": { "type": "array", "description": "The specified entity attributes will be filled. Comma separated values expected." }, "externalIds": { "type": "array", "description": "If specified, retrieves documents associated with external ids, comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebase\_labels Get labels **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `name` | string | No | — | Filter to return the labels that contains the given phrase in the name. | | `includeDocumentCount` | boolean | No | — | If specified, retrieves the number of documents related to label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "name": { "type": "string", "description": "Filter to return the labels that contains the given phrase in the name." }, "includeDocumentCount": { "type": "boolean", "description": "If specified, retrieves the number of documents related to label." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledge\_knowledgebases Get knowledge bases **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `limit` | string | No | — | Number of entities to return. Maximum of 100. Deprecated in favour of pageSize | | `pageSize` | string | No | — | Number of entities to return. Maximum of 100. | | `name` | string | No | — | Filter by Name. | | `coreLanguage` | string | No | — | Filter by core language. | | `published` | boolean | No | — | Filter by published status. | | `sortBy` | string | No | — | Sort by. | | `sortOrder` | string | No | — | Sort Order. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "limit": { "type": "string", "description": "Number of entities to return. Maximum of 100. Deprecated in favour of pageSize" }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 100." }, "name": { "type": "string", "description": "Filter by Name." }, "coreLanguage": { "type": "string", "description": "Filter by core language.", "enum": [ "en-US", "en-UK", "en-AU", "en-CA", "en-HK", "en-IN", "en-IE", "en-NZ", "en-PH", "en-SG", "en-ZA", "de-DE", "de-AT", "de-CH", "es-AR", "es-CO", "es-MX", "es-US", "es-ES", "fr-FR", "fr-BE", "fr-CA", "fr-CH", "pt-BR", "pt-PT", "nl-NL", "nl-BE", "it-IT", "ca-ES", "tr-TR", "sv-SE", "fi-FI", "nb-NO", "da-DK", "ja-JP", "ar-AE", "zh-CN", "zh-TW", "zh-HK", "ko-KR", "pl-PL", "hi-IN", "th-TH", "hu-HU", "vi-VN", "uk-UA", "cs-CZ", "fil-PH", "ms-MY", "he-IL", "el-GR" ] }, "published": { "type": "boolean", "description": "Filter by published status." }, "sortBy": { "type": "string", "description": "Sort by.", "enum": [ "Name", "Date" ] }, "sortOrder": { "type": "string", "description": "Sort Order.", "enum": [ "ASC", "ascending", "DESC", "descending" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase Get knowledge base **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_categories Get categories **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `parentId` | string | No | — | If specified, retrieves the children categories by parent category ID. | | `isRoot` | boolean | No | — | If specified, retrieves only the root categories. | | `name` | string | No | — | Filter to return the categories that starts with the given category name. | | `sortBy` | string | No | — | Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically | | `expand` | string | No | — | The specified entity attribute will be filled. Supported value:"Ancestors": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. | | `includeDocumentCount` | boolean | No | — | If specified, retrieves the number of documents related to category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "parentId": { "type": "string", "description": "If specified, retrieves the children categories by parent category ID." }, "isRoot": { "type": "boolean", "description": "If specified, retrieves only the root categories." }, "name": { "type": "string", "description": "Filter to return the categories that starts with the given category name." }, "sortBy": { "type": "string", "description": "Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically", "enum": [ "Name", "Hierarchy" ] }, "expand": { "type": "string", "description": "The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors." }, "includeDocumentCount": { "type": "boolean", "description": "If specified, retrieves the number of documents related to category." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_category Get category **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `categoryId` | string | Yes | — | Category ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "categoryId": { "type": "string", "description": "Category ID" } }, "required": [ "PCID", "knowledgeBaseId", "categoryId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document Get document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. | | `state` | string | No | — | "when state is "Draft", draft version of the document is returned,otherwise by default published version is returned in the response. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "category", "labels", "variations" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20." }, "state": { "type": "string", "description": "\"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response.", "enum": [ "Draft", "Published" ] } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_feedback Get a list of feedback records given on a document **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `onlyCommented` | boolean | No | — | If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. | | `documentVersionId` | string | No | — | Document version ID to filter by. Supported only if onlyCommented=true is set. | | `documentVariationId` | string | No | — | Document variation ID to filter by. Supported only if onlyCommented=true is set. | | `appType` | string | No | — | Application type to filter by. Supported only if onlyCommented=true is set. | | `queryType` | string | No | — | Query type to filter by. Supported only if onlyCommented=true is set. | | `userId` | string | No | — | The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. | | `queueId` | string | No | — | Queue ID to filter by. Supported only if onlyCommented=true is set. | | `state` | string | No | — | State to filter by. Supported only if onlyCommented=true is set. Default: Final | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "onlyCommented": { "type": "boolean", "description": "If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false." }, "documentVersionId": { "type": "string", "description": "Document version ID to filter by. Supported only if onlyCommented=true is set." }, "documentVariationId": { "type": "string", "description": "Document variation ID to filter by. Supported only if onlyCommented=true is set." }, "appType": { "type": "string", "description": "Application type to filter by. Supported only if onlyCommented=true is set.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "queryType": { "type": "string", "description": "Query type to filter by. Supported only if onlyCommented=true is set.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "userId": { "type": "string", "description": "The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set." }, "queueId": { "type": "string", "description": "Queue ID to filter by. Supported only if onlyCommented=true is set." }, "state": { "type": "string", "description": "State to filter by. Supported only if onlyCommented=true is set. Default: Final", "enum": [ "All", "Draft", "Final" ] } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_feedback\_feedback\_id Get a single feedback record given on a document **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `feedbackId` | string | Yes | — | Feedback ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "feedbackId": { "type": "string", "description": "Feedback ID." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "feedbackId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_variation Get a variation for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------- | | `documentVariationId` | string | Yes | — | Globally unique identifier for a document variation. | | `documentId` | string | Yes | — | Globally unique identifier for a document. | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for a knowledge base. | | `documentState` | string | No | — | The state of the document. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentVariationId": { "type": "string", "description": "Globally unique identifier for a document variation." }, "documentId": { "type": "string", "description": "Globally unique identifier for a document." }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for a knowledge base." }, "documentState": { "type": "string", "description": "The state of the document.", "enum": [ "Draft", "Published" ] }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "contentUrl" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "documentVariationId", "documentId", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_variations Get variations for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `documentState` | string | No | — | The state of the document. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "documentState": { "type": "string", "description": "The state of the document.", "enum": [ "Draft", "Published" ] }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "contentUrl" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_version Get document version. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `versionId` | string | Yes | — | Globally unique identifier for the document version. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "versionId": { "type": "string", "description": "Globally unique identifier for the document version." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "category", "labels" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "versionId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_version\_variation Get variation for the given document version. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `versionId` | string | Yes | — | Globally unique identifier for the document version. | | `variationId` | string | Yes | — | Globally unique identifier for the document version variation. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "versionId": { "type": "string", "description": "Globally unique identifier for the document version." }, "variationId": { "type": "string", "description": "Globally unique identifier for the document version variation." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "versionId", "variationId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_version\_variations Get variations for the given document version. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `versionId` | string | Yes | — | Globally unique identifier for the document version. | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "versionId": { "type": "string", "description": "Globally unique identifier for the document version." }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "versionId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_document\_versions Get document versions. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "category", "labels" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId", "documentId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_documents Get documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `interval` | string | No | — | Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ | | `documentId` | string\[] | No | — | Retrieves the specified documents, comma separated values expected. | | `categoryId` | string\[] | No | — | If specified, retrieves documents associated with category ids, comma separated values expected. | | `includeSubcategories` | boolean | No | — | Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. | | `includeDrafts` | boolean | No | — | If includeDrafts is true, Documents in the draft state are also returned in the response. | | `labelIds` | string\[] | No | — | If specified, retrieves documents associated with label ids, comma separated values expected. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | | `externalIds` | string\[] | No | — | If specified, retrieves documents associated with external ids, comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "interval": { "type": "string", "description": "Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ" }, "documentId": { "type": "array", "items": { "type": "string" }, "description": "Retrieves the specified documents, comma separated values expected." }, "categoryId": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves documents associated with category ids, comma separated values expected." }, "includeSubcategories": { "type": "boolean", "description": "Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories." }, "includeDrafts": { "type": "boolean", "description": "If includeDrafts is true, Documents in the draft state are also returned in the response." }, "labelIds": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves documents associated with label ids, comma separated values expected." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "category", "labels" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." }, "externalIds": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves documents associated with external ids, comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_label Get label **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `labelId` | string | Yes | — | Label ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "labelId": { "type": "string", "description": "Label ID" } }, "required": [ "PCID", "knowledgeBaseId", "labelId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_labels Get labels **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `name` | string | No | — | Filter to return the labels that contains the given phrase in the name. | | `includeDocumentCount` | boolean | No | — | If specified, retrieves the number of documents related to label. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "name": { "type": "string", "description": "Filter to return the labels that contains the given phrase in the name." }, "includeDocumentCount": { "type": "boolean", "description": "If specified, retrieves the number of documents related to label." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_operations Get operations **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `userId` | string\[] | No | — | If specified, retrieves operations associated with user ids, comma separated values expected. | | `type` | string\[] | No | — | If specified, retrieves operations with specified operation type, comma separated values expected. | | `status` | string\[] | No | — | If specified, retrieves operations with specified operation status, comma separated values expected. | | `interval` | string | No | — | Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ | | `sourceId` | string\[] | No | — | If specified, retrieves operations associated with source ids, comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "userId": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves operations associated with user ids, comma separated values expected." }, "type": { "type": "array", "items": { "type": "string", "enum": [ "Export", "Import", "Parse", "Sync" ] }, "description": "If specified, retrieves operations with specified operation type, comma separated values expected." }, "status": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves operations with specified operation status, comma separated values expected." }, "interval": { "type": "string", "description": "Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ" }, "sourceId": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves operations associated with source ids, comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_operations\_users\_query Get ids of operation creator users and oauth clients **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_parse\_job Get parse job report **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `parseJobId` | string | Yes | — | Parse job ID | | `expand` | string\[] | No | — | If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "parseJobId": { "type": "string", "description": "Parse job ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "urls" ] }, "description": "If expand contains 'urls' downloadURL and failedEntitiesURL will be filled." } }, "required": [ "PCID", "knowledgeBaseId", "parseJobId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_sources Get Knowledge integration sources **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `type` | string | No | — | If specified, retrieves integration sources with specified integration type. | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | | `ids` | string\[] | No | — | If specified, retrieves integration sources with specified IDs. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "type": { "type": "string", "description": "If specified, retrieves integration sources with specified integration type.", "enum": [ "Salesforce", "ServiceNow" ] }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "lastsync" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." }, "ids": { "type": "array", "items": { "type": "string" }, "description": "If specified, retrieves integration sources with specified IDs." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_sources\_salesforce\_source\_id Get Salesforce Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "lastsync" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId", "sourceId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_sources\_servicenow\_source\_id Get ServiceNow Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | | `expand` | string\[] | No | — | The specified entity attributes will be filled. Comma separated values expected. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "lastsync" ] }, "description": "The specified entity attributes will be filled. Comma separated values expected." } }, "required": [ "PCID", "knowledgeBaseId", "sourceId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_synchronize\_job Get synchronization job report **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `syncJobId` | string | Yes | — | Synchronization job ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "syncJobId": { "type": "string", "description": "Synchronization job ID" } }, "required": [ "PCID", "knowledgeBaseId", "syncJobId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_unanswered\_group Get knowledge base unanswered group for a particular groupId **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `groupId` | string | Yes | — | The ID of the group to be retrieved. | | `app` | string | No | — | The app value to be used for filtering phrases. | | `dateStart` | string | No | — | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `dateEnd` | string | No | — | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "groupId": { "type": "string", "description": "The ID of the group to be retrieved." }, "app": { "type": "string", "description": "The app value to be used for filtering phrases.", "enum": [ "SupportCenter", "MessengerKnowledgeApp", "BotFlow", "Assistant", "SmartAdvisor" ] }, "dateStart": { "type": "string", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "dateEnd": { "type": "string", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } }, "required": [ "PCID", "knowledgeBaseId", "groupId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_unanswered\_group\_phrasegroup Get knowledge base unanswered phrase group for a particular phraseGroupId **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `groupId` | string | Yes | — | The ID of the group to be retrieved. | | `phraseGroupId` | string | Yes | — | The ID of the phraseGroup to be retrieved. | | `app` | string | No | — | The app value to be used for filtering phrases. | | `dateStart` | string | No | — | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `dateEnd` | string | No | — | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "groupId": { "type": "string", "description": "The ID of the group to be retrieved." }, "phraseGroupId": { "type": "string", "description": "The ID of the phraseGroup to be retrieved." }, "app": { "type": "string", "description": "The app value to be used for filtering phrases.", "enum": [ "SupportCenter", "MessengerKnowledgeApp", "BotFlow", "Assistant", "SmartAdvisor" ] }, "dateStart": { "type": "string", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "dateEnd": { "type": "string", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } }, "required": [ "PCID", "knowledgeBaseId", "groupId", "phraseGroupId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_unanswered\_groups Get knowledge base unanswered groups **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `app` | string | No | — | The app value to be used for filtering phrases. | | `dateStart` | string | No | — | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `dateEnd` | string | No | — | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "app": { "type": "string", "description": "The app value to be used for filtering phrases.", "enum": [ "SupportCenter", "MessengerKnowledgeApp", "BotFlow", "Assistant", "SmartAdvisor" ] }, "dateStart": { "type": "string", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "dateEnd": { "type": "string", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebase\_uploads\_urls\_job Get content upload from URL job status **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `jobId` | string | Yes | — | Upload job ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "jobId": { "type": "string", "description": "Upload job ID" } }, "required": [ "PCID", "knowledgeBaseId", "jobId" ] } ``` *** ## genesys\_knowledge\_get\_knowledgebases Get knowledge bases **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------- | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `limit` | string | No | — | Number of entities to return. Maximum of 100. Deprecated in favour of pageSize | | `pageSize` | string | No | — | Number of entities to return. Maximum of 100. | | `name` | string | No | — | Filter by Name. | | `coreLanguage` | string | No | — | Filter by core language. | | `published` | boolean | No | — | Filter by published status. | | `sortBy` | string | No | — | Sort by. | | `sortOrder` | string | No | — | Sort Order. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "limit": { "type": "string", "description": "Number of entities to return. Maximum of 100. Deprecated in favour of pageSize" }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 100." }, "name": { "type": "string", "description": "Filter by Name." }, "coreLanguage": { "type": "string", "description": "Filter by core language.", "enum": [ "en-US", "en-UK", "en-AU", "en-CA", "en-HK", "en-IN", "en-IE", "en-NZ", "en-PH", "en-SG", "en-ZA", "de-DE", "de-AT", "de-CH", "es-AR", "es-CO", "es-MX", "es-US", "es-ES", "fr-FR", "fr-BE", "fr-CA", "fr-CH", "pt-BR", "pt-PT", "nl-NL", "nl-BE", "it-IT", "ca-ES", "tr-TR", "sv-SE", "fi-FI", "nb-NO", "da-DK", "ja-JP", "ar-AE", "zh-CN", "zh-TW", "zh-HK", "ko-KR", "pl-PL", "hi-IN", "th-TH", "hu-HU", "vi-VN", "uk-UA", "cs-CZ", "fil-PH", "ms-MY", "he-IL", "el-GR" ] }, "published": { "type": "boolean", "description": "Filter by published status." }, "sortBy": { "type": "string", "description": "Sort by.", "enum": [ "Name", "Date" ] }, "sortOrder": { "type": "string", "description": "Sort Order.", "enum": [ "ASC", "ascending", "DESC", "descending" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_knowledge\_get\_setting Get Knowledge setting. **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | --------------------- | | `knowledgeSettingId` | string | Yes | — | Knowledge Setting ID. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeSettingId": { "type": "string", "description": "Knowledge Setting ID." } }, "required": [ "PCID", "knowledgeSettingId" ] } ``` *** ## genesys\_knowledge\_get\_settings Get Knowledge settings. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------- | | `before` | string | No | — | The cursor that points to the start of the set of entities that has been returned. | | `after` | string | No | — | The cursor that points to the end of the set of entities that has been returned. | | `pageSize` | string | No | — | Number of entities to return. Maximum of 200. | | `name` | string | No | — | Knowledge setting name to search upon. | | `sourceId` | string | No | — | Source ID to filter knowledge settings by. | | `sortBy` | string | No | — | Field to sort the knowledge settings on. | | `sortOrder` | string | No | — | Sorting order for knowledge settings. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "before": { "type": "string", "description": "The cursor that points to the start of the set of entities that has been returned." }, "after": { "type": "string", "description": "The cursor that points to the end of the set of entities that has been returned." }, "pageSize": { "type": "string", "description": "Number of entities to return. Maximum of 200." }, "name": { "type": "string", "description": "Knowledge setting name to search upon." }, "sourceId": { "type": "string", "description": "Source ID to filter knowledge settings by." }, "sortBy": { "type": "string", "description": "Field to sort the knowledge settings on.", "enum": [ "dateModified", "name" ] }, "sortOrder": { "type": "string", "description": "Sorting order for knowledge settings.", "enum": [ "Asc", "Desc" ] } }, "required": [ "PCID" ] } ``` *** ## genesys\_knowledge\_patch\_guest\_session\_documents\_search\_search\_id Update search result. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | -------------------------------------- | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `searchId` | string | Yes | — | Search Result ID | | `answered` | boolean | Yes | — | Mark the search as answered/unanswered | | `selectedAnswer` | object | No | — | Selected Answer | | `selectedAnswers` | object\[] | No | — | The search results selected as answers | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "searchId": { "type": "string", "description": "Search Result ID" }, "answered": { "type": "boolean", "description": "Mark the search as answered/unanswered" }, "selectedAnswer": { "type": "object", "description": "Selected Answer", "properties": { "document": { "type": "object", "description": "The document value" } }, "required": [ "document" ] }, "selectedAnswers": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "object", "description": "The document value" } }, "required": [ "document" ] }, "description": "The search results selected as answers" } }, "required": [ "PCID", "sessionId", "searchId", "answered" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase Update knowledge base **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `description` | string | No | — | Knowledge base description | | `name` | string | No | — | Knowledge base name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "description": { "type": "string", "description": "Knowledge base description" }, "name": { "type": "string", "description": "Knowledge base name" } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_category Update category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ---------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `categoryId` | string | Yes | — | Category ID | | `description` | string | No | — | The description value | | `externalId` | string | No | — | The external id associated with the category. | | `id` | string | No | — | The globally unique identifier for the object. | | `name` | string | No | — | The name of the category. | | `parentCategoryId` | string | No | — | The category to which this category belongs. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "categoryId": { "type": "string", "description": "Category ID" }, "description": { "type": "string", "description": "The description value" }, "externalId": { "type": "string", "description": "The external id associated with the category." }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name of the category." }, "parentCategoryId": { "type": "string", "description": "The category to which this category belongs." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "knowledgeBaseId", "categoryId" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_chunks\_search\_search\_id Register chunk search result. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | --------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge Base ID | | `searchId` | string | Yes | — | Unique identifier of search request | | `answered` | boolean | Yes | — | Mark the chunks search as answered/unanswered | | `selectedAnswers` | object\[] | No | — | The search results selected as answers | | `sessionId` | string | No | — | The unique identifier of this session | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge Base ID" }, "searchId": { "type": "string", "description": "Unique identifier of search request" }, "answered": { "type": "boolean", "description": "Mark the chunks search as answered/unanswered" }, "selectedAnswers": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "object", "description": "The document value" } }, "required": [ "document" ] }, "description": "The search results selected as answers" }, "sessionId": { "type": "string", "description": "The unique identifier of this session" } }, "required": [ "PCID", "knowledgeBaseId", "searchId", "answered" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_document Update document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `alternatives` | object\[] | No | — | List of alternate phrases related to the title which improves search results. | | `categoryId` | string | No | — | The category associated with the document. | | `externalId` | string | No | — | The external id associated with the document. | | `externalUrl` | string | No | — | The URL to external document. | | `id` | string | No | — | The globally unique identifier for the object. | | `labelIds` | string\[] | No | — | The ids of labels associated with the document. | | `selfUri` | string | No | — | The URI for this object | | `title` | string | Yes | — | Document title. | | `visible` | boolean | No | — | Indicates if the knowledge document should be included in search results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "alternatives": { "type": "array", "items": { "type": "object", "properties": { "phrase": { "type": "string", "description": "Alternate phrasing to the document title, having a limit of 500 words." }, "autocomplete": { "type": "boolean", "description": "Autocomplete enabled for the alternate phrase." } }, "required": [ "autocomplete", "phrase" ] }, "description": "List of alternate phrases related to the title which improves search results." }, "categoryId": { "type": "string", "description": "The category associated with the document." }, "externalId": { "type": "string", "description": "The external id associated with the document." }, "externalUrl": { "type": "string", "description": "The URL to external document." }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "labelIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of labels associated with the document." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "title": { "type": "string", "description": "Document title." }, "visible": { "type": "boolean", "description": "Indicates if the knowledge document should be included in search results." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "title" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_document\_feedback\_feedback\_id Update feedback on a document **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `feedbackId` | string | Yes | — | Feedback ID. | | `comment` | string | No | — | Feedback comment | | `rating` | string | Yes | — | Feedback rating. | | `reason` | string | No | — | Feedback reason | | `state` | string | No | — | Feedback state | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "feedbackId": { "type": "string", "description": "Feedback ID." }, "comment": { "type": "string", "description": "Feedback comment" }, "rating": { "type": "string", "description": "Feedback rating.", "enum": [ "Negative", "Positive" ] }, "reason": { "type": "string", "description": "Feedback reason", "enum": [ "DocumentContent", "SearchResults" ] }, "state": { "type": "string", "description": "Feedback state", "enum": [ "Draft", "Final" ] } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "feedbackId", "rating" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_document\_variation Update a variation for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `documentVariationId` | string | Yes | — | Globally unique identifier for a document variation. | | `documentId` | string | Yes | — | Globally unique identifier for a document. | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for a knowledge base. | | `body` | object | No | — | The body value | | `contexts` | object\[] | Yes | — | The context values associated with the variation. | | `dateCreated` | string | No | — | The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dateModified` | string | No | — | The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `document` | object | No | — | The document value | | `documentVersion` | object | No | — | Document Version | | `id` | string | No | — | The globally unique identifier for the variation. | | `name` | string | No | — | The name of the variation. | | `priority` | integer | No | — | The priority of the variation. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "documentVariationId": { "type": "string", "description": "Globally unique identifier for a document variation." }, "documentId": { "type": "string", "description": "Globally unique identifier for a document." }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for a knowledge base." }, "body": { "type": "object", "description": "The body value", "properties": { "blocks": { "type": "array", "items": { "type": "object" }, "description": "The list of building blocks for the document body." } }, "required": [ "blocks" ] }, "contexts": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "object", "description": "The context value" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the knowledge context value." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "description": "The list of knowledge context values associated with the variation." } }, "required": [ "context", "values" ] }, "description": "The context values associated with the variation." }, "dateCreated": { "type": "string", "description": "The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateModified": { "type": "string", "description": "The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "document": { "type": "object", "description": "The document value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the document." }, "knowledgeBase": { "type": "object", "description": "Knowledge Base" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "id", "knowledgeBase" ] }, "documentVersion": { "type": "object", "description": "Document Version", "properties": { "id": { "type": "string", "description": "The id value" }, "selfUri": { "type": "string", "description": "Self Uri" } } }, "id": { "type": "string", "description": "The globally unique identifier for the variation." }, "name": { "type": "string", "description": "The name of the variation." }, "priority": { "type": "integer", "description": "The priority of the variation." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "documentVariationId", "documentId", "knowledgeBaseId", "contexts" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_documents\_search\_search\_id Update search result. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | The ID of knowledge base containing the documents to query. | | `searchId` | string | Yes | — | Search Result ID | | `answered` | boolean | Yes | — | Mark the search as answered/unanswered | | `selectedAnswer` | object | No | — | Selected Answer | | `selectedAnswers` | object\[] | No | — | The search results selected as answers | | `sessionId` | string | No | — | The unique identifier of this session | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "The ID of knowledge base containing the documents to query." }, "searchId": { "type": "string", "description": "Search Result ID" }, "answered": { "type": "boolean", "description": "Mark the search as answered/unanswered" }, "selectedAnswer": { "type": "object", "description": "Selected Answer", "properties": { "document": { "type": "object", "description": "The document value" } }, "required": [ "document" ] }, "selectedAnswers": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "object", "description": "The document value" } }, "required": [ "document" ] }, "description": "The search results selected as answers" }, "sessionId": { "type": "string", "description": "The unique identifier of this session" } }, "required": [ "PCID", "knowledgeBaseId", "searchId", "answered" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_label Update label **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `labelId` | string | Yes | — | Label ID | | `color` | string | No | — | The color for the label. | | `externalId` | string | No | — | The external id associated with the label. | | `id` | string | No | — | The globally unique identifier for the object. | | `name` | string | No | — | The name of the label. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "labelId": { "type": "string", "description": "Label ID" }, "color": { "type": "string", "description": "The color for the label." }, "externalId": { "type": "string", "description": "The external id associated with the label." }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name of the label." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "knowledgeBaseId", "labelId" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_parse\_job Send update to the parse operation **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `parseJobId` | string | Yes | — | Parse job ID | | `hints` | string\[] | No | — | Hinted titles for the parser. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "parseJobId": { "type": "string", "description": "Parse job ID" }, "hints": { "type": "array", "items": { "type": "string" }, "description": "Hinted titles for the parser." } }, "required": [ "PCID", "knowledgeBaseId", "parseJobId" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_synchronize\_job Update synchronization job **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `syncJobId` | string | Yes | — | Synchronization job ID | | `status` | string | Yes | — | New status for an existing sync operation | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "syncJobId": { "type": "string", "description": "Synchronization job ID" }, "status": { "type": "string", "description": "New status for an existing sync operation", "enum": [ "Created", "ValidationInProgress", "ValidationCompleted", "ValidationFailed", "Started", "InProgress", "Completed", "PartialCompleted", "Failed", "AbortRequested", "Aborted" ] } }, "required": [ "PCID", "knowledgeBaseId", "syncJobId", "status" ] } ``` *** ## genesys\_knowledge\_patch\_knowledgebase\_unanswered\_group\_phrasegroup Update a Knowledge base unanswered phrase group **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `groupId` | string | Yes | — | The ID of the group to be updated. | | `phraseGroupId` | string | Yes | — | The ID of the phraseGroup to be updated. | | `dateEnd` | string | No | — | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `dateStart` | string | No | — | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | `phraseAssociations` | object\[] | Yes | — | List of phrases and documents to be linked | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "groupId": { "type": "string", "description": "The ID of the group to be updated." }, "phraseGroupId": { "type": "string", "description": "The ID of the phraseGroup to be updated." }, "dateEnd": { "type": "string", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "dateStart": { "type": "string", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, "phraseAssociations": { "type": "array", "items": { "type": "object", "properties": { "phraseId": { "type": "string", "description": "Id of the phrase to be linked" }, "documentId": { "type": "string", "description": "Id of the document to be linked" } }, "required": [ "documentId", "phraseId" ] }, "description": "List of phrases and documents to be linked" } }, "required": [ "PCID", "knowledgeBaseId", "groupId", "phraseGroupId", "phraseAssociations" ] } ``` *** ## genesys\_knowledge\_patch\_setting Update Knowledge setting. **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------- | | `knowledgeSettingId` | string | Yes | — | Knowledge Setting ID. | | `description` | string | No | — | Knowledge setting description. | | `filter` | object | No | — | The filter value | | `generationSetting` | object | No | — | Generation Setting | | `name` | string | Yes | — | Knowledge setting name. | | `sources` | object\[] | Yes | — | Knowledge source information to search upon. | | `stateful` | boolean | No | — | Indicates if stateful search and generation is enabled for the knowledge setting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeSettingId": { "type": "string", "description": "Knowledge Setting ID." }, "description": { "type": "string", "description": "Knowledge setting description." }, "filter": { "type": "object", "description": "The filter value", "properties": { "allOf": { "type": "array", "items": { "type": "string" }, "description": "Tags that must all be present (AND)." }, "anyOfGroups": { "type": "array", "items": { "type": "array" }, "description": "OR groups ANDed together; within each group at least one tag must match." }, "noneOf": { "type": "array", "items": { "type": "string" }, "description": "Tags that must not be present on matching chunks." } } }, "generationSetting": { "type": "object", "description": "Generation Setting", "properties": { "answerGeneration": { "type": "boolean", "description": "Indicates if answer generation is enabled for the setting." }, "generationLanguage": { "type": "string", "description": "Answer generation language.", "enum": [ "ar-AE", "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-PH", "en-SG", "en-US", "en-ZA", "es-AR", "es-CO", "es-ES", "es-MX", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "hu-HU", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "el-GR", "fil-PH", "he-IL", "ms-MY", "pl-PL", "th-TH" ] } }, "required": [ "answerGeneration" ] }, "name": { "type": "string", "description": "Knowledge setting name." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Source Id." }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } }, "required": [ "id" ] }, "description": "Knowledge source information to search upon." }, "stateful": { "type": "boolean", "description": "Indicates if stateful search and generation is enabled for the knowledge setting." } }, "required": [ "PCID", "knowledgeSettingId", "name", "sources" ] } ``` *** ## genesys\_knowledge\_post\_documentuploads Creates a presigned URL for uploading a knowledge import file with a set of documents **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentMd5` | string | No | — | Content MD5 of the file to upload | | `contentType` | string | No | — | The content type of the file to upload. Allows all MIME types | | `fileName` | string | No | — | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \{^}%\`]">\[\~\<#\| | | `serverSideEncryption` | string | No | — | Server Side Encryption | | `signedUrlTimeoutSeconds` | integer | No | — | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contentMd5": { "type": "string", "description": "Content MD5 of the file to upload" }, "contentType": { "type": "string", "description": "The content type of the file to upload. Allows all MIME types" }, "fileName": { "type": "string", "description": "Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|" }, "serverSideEncryption": { "type": "string", "description": "Server Side Encryption", "enum": [ "AES256" ] }, "signedUrlTimeoutSeconds": { "type": "integer", "description": "The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds" } }, "required": [ "PCID" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_document\_copies Indicate that the document was copied by the user. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `documentId` | string | Yes | — | Document ID | | `application` | object | No | — | The application value | | `documentVariationId` | string | Yes | — | The variation of the document whose content was copied. | | `documentVersionId` | string | Yes | — | The version of the document whose content was copied. | | `queryType` | string | No | — | The type of the query that surfaced the document. | | `searchId` | string | No | — | The search that surfaced the document whose content was copied. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "documentId": { "type": "string", "description": "Document ID" }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "documentVariationId": { "type": "string", "description": "The variation of the document whose content was copied." }, "documentVersionId": { "type": "string", "description": "The version of the document whose content was copied." }, "queryType": { "type": "string", "description": "The type of the query that surfaced the document.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search that surfaced the document whose content was copied." }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "sessionId", "documentId", "documentVariationId", "documentVersionId" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_document\_feedback Give feedback on a document **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `documentId` | string | Yes | — | Document ID. | | `application` | object | No | — | The application value | | `comment` | string | No | — | Free-text comment of the feedback. Maximum length: 2000 characters. | | `dateCreated` | string | No | — | The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `document` | object | Yes | — | The document value | | `documentVariation` | object | Yes | — | Document Variation | | `id` | string | No | — | The globally unique identifier for the object. | | `queryType` | string | No | — | The type of the query that surfaced the document on which the feedback was given. | | `rating` | string | Yes | — | Feedback rating. | | `reason` | string | No | — | Feedback reason. | | `search` | object | No | — | The search value | | `state` | string | No | — | The state of the feedback. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "documentId": { "type": "string", "description": "Document ID." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "comment": { "type": "string", "description": "Free-text comment of the feedback. Maximum length: 2000 characters." }, "dateCreated": { "type": "string", "description": "The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "document": { "type": "object", "description": "The document value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the document." }, "versionId": { "type": "string", "description": "The globally unique identifier for the version of the document." } }, "required": [ "versionId" ] }, "documentVariation": { "type": "object", "description": "Document Variation", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." } }, "required": [ "id" ] }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "queryType": { "type": "string", "description": "The type of the query that surfaced the document on which the feedback was given.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "rating": { "type": "string", "description": "Feedback rating.", "enum": [ "Negative", "Positive" ] }, "reason": { "type": "string", "description": "Feedback reason.", "enum": [ "DocumentContent", "SearchResults" ] }, "search": { "type": "object", "description": "The search value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." } }, "required": [ "id" ] }, "state": { "type": "string", "description": "The state of the feedback.", "enum": [ "Draft", "Final" ] }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "sessionId", "documentId", "document", "documentVariation", "rating" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_document\_views Create view event for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `documentId` | string | Yes | — | Document ID | | `documentVariationId` | string | Yes | — | The variation of the viewed document. | | `documentVersionId` | string | Yes | — | The version of the viewed document. | | `queryType` | string | No | — | The type of the query that surfaced the document. | | `searchId` | string | No | — | The search that surfaced the viewed document. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "documentId": { "type": "string", "description": "Document ID" }, "documentVariationId": { "type": "string", "description": "The variation of the viewed document." }, "documentVersionId": { "type": "string", "description": "The version of the viewed document." }, "queryType": { "type": "string", "description": "The type of the query that surfaced the document.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search that surfaced the viewed document." }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "sessionId", "documentId", "documentVariationId", "documentVersionId" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_documents\_answers Answer documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `answerMode` | string\[] | No | — | Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight | | `appType` | string | No | — | The appType | | `insertHighlightIntoVariationContent` | boolean | No | — | If specified - insert highlight data into the variation content. | | `language` | string | No | — | The language of the documents. | | `query` | string | No | — | The search query. | | `queryType` | string | No | — | The query type | | `searchId` | string | No | — | The search id. | | `variationIds` | string\[] | Yes | — | The variation Ids to answer. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "answerMode": { "type": "array", "items": { "type": "string", "enum": [ "AnswerHighlight", "AnswerGeneration" ] }, "description": "Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight" }, "appType": { "type": "string", "description": "The appType", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "insertHighlightIntoVariationContent": { "type": "boolean", "description": "If specified - insert highlight data into the variation content." }, "language": { "type": "string", "description": "The language of the documents.", "enum": [ "en-US", "en-UK", "en-AU", "en-CA", "en-HK", "en-IN", "en-IE", "en-NZ", "en-PH", "en-SG", "en-ZA", "de-DE", "de-AT", "de-CH", "es-AR", "es-CO", "es-MX", "es-US", "es-ES", "fr-FR", "fr-BE", "fr-CA", "fr-CH", "pt-BR", "pt-PT", "nl-NL", "nl-BE", "it-IT", "ca-ES", "tr-TR", "sv-SE", "fi-FI", "nb-NO", "da-DK", "ja-JP", "ar-AE", "zh-CN", "zh-TW", "zh-HK", "ko-KR", "pl-PL", "hi-IN", "th-TH", "hu-HU", "vi-VN", "uk-UA", "cs-CZ", "fil-PH", "ms-MY", "he-IL", "el-GR" ] }, "query": { "type": "string", "description": "The search query." }, "queryType": { "type": "string", "description": "The query type", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search id." }, "variationIds": { "type": "array", "items": { "type": "string" }, "description": "The variation Ids to answer." } }, "required": [ "PCID", "sessionId", "variationIds" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_documents\_presentations Indicate that documents were presented to the user. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `application` | object | No | — | The application value | | `documents` | object\[] | Yes | — | The presented documents | | `queryType` | string | No | — | The type of the query that surfaced the documents. | | `searchId` | string | No | — | The search that surfaced the documents that were presented. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "description": "The ID of the document." }, "documentVariationId": { "type": "string", "description": "The variation of the document." }, "documentVersionId": { "type": "string", "description": "The version of the document." }, "surfacingMethod": { "type": "string", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ], "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown." } }, "required": [ "documentId", "documentVariationId", "documentVersionId" ] }, "description": "The presented documents" }, "queryType": { "type": "string", "description": "The type of the query that surfaced the documents.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search that surfaced the documents that were presented." }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "sessionId", "documents" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_documents\_search Search the documents in a guest session. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `expand` | string\[] | No | — | Fields, if any, to expand for each document in the search result matching the query. | | `answerHighlightTopResults` | integer | No | — | The number of articles to be sent for answer-highlighting. Can range from 1-5. | | `includeDraftDocuments` | boolean | No | — | Indicates whether the search results would also include draft documents. | | `pageCount` | integer | No | — | Number of pages returned in the result calculated according to the pageSize and the total | | `pageNumber` | integer | No | — | Page number of the returned results. | | `pageSize` | integer | No | — | Page size of the returned results. | | `query` | string | Yes | — | Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. | | `queryType` | string | No | — | The type of the query that initiates the search. | | `searchId` | string | No | — | The globally unique identifier for the search. | | `total` | integer | No | — | The total number of documents matching the query. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "documentVariations", "documentAlternatives", "knowledgeBaseLanguageCode" ] }, "description": "Fields, if any, to expand for each document in the search result matching the query." }, "answerHighlightTopResults": { "type": "integer", "description": "The number of articles to be sent for answer-highlighting. Can range from 1-5." }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the search results would also include draft documents." }, "pageCount": { "type": "integer", "description": "Number of pages returned in the result calculated according to the pageSize and the total" }, "pageNumber": { "type": "integer", "description": "Page number of the returned results." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "query": { "type": "string", "description": "Query to search content in the knowledge base. Maximum of 30 records per query can be fetched." }, "queryType": { "type": "string", "description": "The type of the query that initiates the search.", "enum": [ "AutoSearch", "ManualSearch", "Suggestion" ] }, "searchId": { "type": "string", "description": "The globally unique identifier for the search." }, "total": { "type": "integer", "description": "The total number of documents matching the query." } }, "required": [ "PCID", "sessionId", "query" ] } ``` *** ## genesys\_knowledge\_post\_guest\_session\_documents\_search\_suggestions Query the knowledge documents to provide suggestions for auto completion. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------- | | `sessionId` | string | Yes | — | Knowledge guest session ID. | | `includeDraftDocuments` | boolean | No | — | Indicates whether the suggestion results would also include draft documents. | | `pageSize` | integer | No | — | Page size of the returned results. | | `query` | string | Yes | — | Query to get autocomplete suggestions for the matching knowledge documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the suggestion results would also include draft documents." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "query": { "type": "string", "description": "Query to get autocomplete suggestions for the matching knowledge documents." } }, "required": [ "PCID", "sessionId", "query" ] } ``` *** ## genesys\_knowledge\_post\_guest\_sessions Create guest session **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- | | `app` | object | Yes | — | The app value | | `contexts` | object\[] | No | — | The session contexts. | | `customerId` | string | Yes | — | An arbitrary ID for the customer starting the session. Used to track multiple sessions started by the same customer. | | `id` | string | No | — | Session ID. | | `journeySessionId` | string | No | — | Journey session ID. Used to get the segments of the customer to filter search results. | | `pageUrl` | string | No | — | URL of the page where the session is started. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "app": { "type": "object", "description": "The app value", "properties": { "deploymentId": { "type": "string", "description": "App deployment ID." }, "type": { "type": "string", "description": "App type.", "enum": [ "MessengerKnowledgeApp", "SupportCenter" ] } }, "required": [ "deploymentId", "type" ] }, "contexts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The context id associated with the session." }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." } } }, "description": "The list of knowledge context values associated with the session." } }, "required": [ "id", "values" ] }, "description": "The session contexts." }, "customerId": { "type": "string", "description": "An arbitrary ID for the customer starting the session. Used to track multiple sessions started by the same customer." }, "id": { "type": "string", "description": "Session ID." }, "journeySessionId": { "type": "string", "description": "Journey session ID. Used to get the segments of the customer to filter search results." }, "pageUrl": { "type": "string", "description": "URL of the page where the session is started." } }, "required": [ "PCID", "app", "customerId" ] } ``` *** ## genesys\_knowledge\_post\_knowledge\_knowledgebase\_documents\_query Query for knowledge documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge Base ID | | `expand` | any\[] | No | — | Fields, if any, to expand for each document in the search result matching the query. | | `filter` | object | No | — | filter | | `includeDraftDocuments` | boolean | No | — | Indicates whether the results would also include draft documents. | | `includeVariations` | string | No | — | Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All. | | `interval` | object | No | — | interval | | `pageNumber` | integer | No | — | Page number of the returned results. | | `pageSize` | integer | No | — | Page size of the returned results. | | `sortBy` | string | No | — | The field in the documents that you want to sort the results by. | | `sortOrder` | string | No | — | The sort order for results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge Base ID" }, "expand": { "type": "array", "description": "Fields, if any, to expand for each document in the search result matching the query." }, "filter": { "type": "object", "description": "filter" }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the results would also include draft documents." }, "includeVariations": { "type": "string", "description": "Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.", "enum": [ "All", "AllMatching", "SingleMostRelevant" ] }, "interval": { "type": "object", "description": "interval" }, "pageNumber": { "type": "integer", "description": "Page number of the returned results." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "sortBy": { "type": "string", "description": "The field in the documents that you want to sort the results by.", "enum": [ "DateCreated", "DateModified", "CategoryName", "LabelName", "ViewCount" ] }, "sortOrder": { "type": "string", "description": "The sort order for results.", "enum": [ "Asc", "Desc" ] } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_post\_knowledge\_knowledgebase\_documents\_search Search the documents in a knowledge base. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | The ID of knowledge base containing the documents to query. | | `expand` | any\[] | No | — | Fields, if any, to expand for each document in the search result matching the query. | | `answerHighlightTopResults` | integer | No | — | The number of articles to be sent for answer-highlighting. Can range from 1-5. | | `answerMode` | any\[] | No | — | Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults. | | `application` | object | No | — | application | | `confidenceThreshold` | number | No | — | The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1. | | `conversationContext` | object | No | — | conversationContext | | `filter` | object | No | — | filter | | `includeDraftDocuments` | boolean | No | — | Indicates whether the search results would also include draft documents. | | `interval` | object | No | — | interval | | `pageCount` | integer | No | — | Number of pages returned in the result calculated according to the pageSize and the total | | `pageNumber` | integer | No | — | Page number of the returned results. | | `pageSize` | integer | No | — | Page size of the returned results. | | `preprocessQuery` | boolean | No | — | Indicates whether the search query should be preprocessed. | | `query` | string | No | — | Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. | | `queryType` | string | No | — | The type of the query that initiates the search. | | `searchId` | string | No | — | The globally unique identifier for the search. | | `sortBy` | string | No | — | The field in the documents that you want to sort the search results by. | | `sortOrder` | string | No | — | The sort order for search results. | | `total` | integer | No | — | The total number of documents matching the query. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "The ID of knowledge base containing the documents to query." }, "expand": { "type": "array", "description": "Fields, if any, to expand for each document in the search result matching the query." }, "answerHighlightTopResults": { "type": "integer", "description": "The number of articles to be sent for answer-highlighting. Can range from 1-5." }, "answerMode": { "type": "array", "description": "Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults." }, "application": { "type": "object", "description": "application" }, "confidenceThreshold": { "type": "number", "description": "The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1." }, "conversationContext": { "type": "object", "description": "conversationContext" }, "filter": { "type": "object", "description": "filter" }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the search results would also include draft documents." }, "interval": { "type": "object", "description": "interval" }, "pageCount": { "type": "integer", "description": "Number of pages returned in the result calculated according to the pageSize and the total" }, "pageNumber": { "type": "integer", "description": "Page number of the returned results." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "preprocessQuery": { "type": "boolean", "description": "Indicates whether the search query should be preprocessed." }, "query": { "type": "string", "description": "Query to search content in the knowledge base. Maximum of 30 records per query can be fetched." }, "queryType": { "type": "string", "description": "The type of the query that initiates the search.", "enum": [ "AutoSearch", "ManualSearch", "Suggestion" ] }, "searchId": { "type": "string", "description": "The globally unique identifier for the search." }, "sortBy": { "type": "string", "description": "The field in the documents that you want to sort the search results by.", "enum": [ "ConfidenceScore", "DateCreated", "DateModified", "CategoryName", "LabelName" ] }, "sortOrder": { "type": "string", "description": "The sort order for search results.", "enum": [ "Asc", "Desc" ] }, "total": { "type": "integer", "description": "The total number of documents matching the query." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_post\_knowledge\_knowledgebase\_documents\_search\_suggestions Query the knowledge documents to provide suggestions for auto completion. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | The ID of knowledge base containing the documents to query. | | `filter` | object | No | — | filter | | `includeDraftDocuments` | boolean | No | — | Indicates whether the suggestion results would also include draft documents. | | `interval` | object | No | — | interval | | `pageSize` | integer | No | — | Page size of the returned results. | | `query` | string | No | — | Query to get autocomplete suggestions for the matching knowledge documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "The ID of knowledge base containing the documents to query." }, "filter": { "type": "object", "description": "filter" }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the suggestion results would also include draft documents." }, "interval": { "type": "object", "description": "interval" }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "query": { "type": "string", "description": "Query to get autocomplete suggestions for the matching knowledge documents." } }, "required": [ "PCID", "knowledgeBaseId" ] } ``` *** ## genesys\_knowledge\_post\_knowledge\_search Get Knowledge Search **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------- | | `application` | object | No | — | application | | `conversationContext` | object | No | — | conversationContext | | `conversationTurns` | any\[] | No | — | List of conversation turns to use for stateful search. | | `generationLanguage` | string | No | — | The language to use for answer generation. | | `knowledgeSettingId` | string | No | — | Knowledge Setting Id to use for search request. | | `query` | string | No | — | Input query to search content on the knowledge setting. | | `queryType` | string | No | — | The type of the query that initiates the search. | | `sessionId` | string | No | — | The session id for search request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "application": { "type": "object", "description": "application" }, "conversationContext": { "type": "object", "description": "conversationContext" }, "conversationTurns": { "type": "array", "description": "List of conversation turns to use for stateful search." }, "generationLanguage": { "type": "string", "description": "The language to use for answer generation.", "enum": [ "ar-AE", "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-PH", "en-SG", "en-US", "en-ZA", "es-AR", "es-CO", "es-ES", "es-MX", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "hu-HU", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "sv-SE", "tr-TR" ] }, "knowledgeSettingId": { "type": "string", "description": "Knowledge Setting Id to use for search request." }, "query": { "type": "string", "description": "Input query to search content on the knowledge setting." }, "queryType": { "type": "string", "description": "The type of the query that initiates the search.", "enum": [ "AutoSearch", "ManualSearch" ] }, "sessionId": { "type": "string", "description": "The session id for search request." } }, "required": [ "PCID" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_categories Create new category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------ | ------ | -------- | ------- | ---------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `description` | string | No | — | The description for the category. | | `externalId` | string | No | — | The external id associated with the category. | | `id` | string | No | — | The globally unique identifier for the object. | | `name` | string | Yes | — | The name of the category. | | `parentCategoryId` | string | No | — | Parent Category Id | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "description": { "type": "string", "description": "The description for the category." }, "externalId": { "type": "string", "description": "The external id associated with the category." }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name of the category." }, "parentCategoryId": { "type": "string", "description": "Parent Category Id" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "knowledgeBaseId", "name" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_chunks\_search Search for chunks in a knowledge base **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge Base ID | | `application` | object | No | — | The application value | | `confidenceThreshold` | number | No | — | The confidence threshold for the chunk results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1. | | `conversationContext` | object | No | — | Conversation Context | | `filter` | object | No | — | The filter value | | `includeDraftDocuments` | boolean | No | — | Indicates whether the chunk results would also include draft documents. | | `pageNumber` | integer | No | — | Page number of the returned results. | | `pageSize` | integer | No | — | Page size of the returned results. | | `preprocessQuery` | boolean | No | — | Indicates whether the chunks search query should be preprocessed. | | `query` | string | Yes | — | Query to search chunks in the knowledge base. | | `queryType` | string | No | — | The type of the query that initiates the chunks search. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge Base ID" }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "confidenceThreshold": { "type": "number", "description": "The confidence threshold for the chunk results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1." }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Unknown", "Callback", "Chat", "Cobrowse", "Email", "Message", "Screenshare", "Video", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "filter": { "type": "object", "description": "The filter value", "properties": { "clauses": { "type": "array", "items": { "type": "object" }, "description": "Documents filter clauses/criteria. Limit of 20 clauses." }, "operator": { "type": "string", "description": "Specifies how the filter clauses will be applied together.", "enum": [ "Or", "And" ] } }, "required": [ "clauses", "operator" ] }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the chunk results would also include draft documents." }, "pageNumber": { "type": "integer", "description": "Page number of the returned results." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "preprocessQuery": { "type": "boolean", "description": "Indicates whether the chunks search query should be preprocessed." }, "query": { "type": "string", "description": "Query to search chunks in the knowledge base." }, "queryType": { "type": "string", "description": "The type of the query that initiates the chunks search.", "enum": [ "AutoSearch", "ManualSearch", "Suggestion" ] } }, "required": [ "PCID", "knowledgeBaseId", "query" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_document\_copies Indicate that the document was copied by the user. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `application` | object | Yes | — | The application value | | `conversationContext` | object | No | — | Conversation Context | | `documentVariationId` | string | Yes | — | The variation of the document whose content was copied. | | `documentVersionId` | string | Yes | — | The version of the document whose content was copied. | | `queryType` | string | No | — | The type of the query that surfaced the document. | | `searchId` | string | No | — | The search that surfaced the document whose content was copied. | | `sessionId` | string | No | — | Knowledge session ID. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Unknown", "Callback", "Chat", "Cobrowse", "Email", "Message", "Screenshare", "Video", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "documentVariationId": { "type": "string", "description": "The variation of the document whose content was copied." }, "documentVersionId": { "type": "string", "description": "The version of the document whose content was copied." }, "queryType": { "type": "string", "description": "The type of the query that surfaced the document.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search that surfaced the document whose content was copied." }, "sessionId": { "type": "string", "description": "Knowledge session ID." }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "application", "documentVariationId", "documentVersionId" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_document\_feedback Give feedback on a document **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `application` | object | Yes | — | The application value | | `comment` | string | No | — | Free-text comment of the feedback. Maximum length: 2000 characters. | | `conversationContext` | object | No | — | Conversation Context | | `dateCreated` | string | No | — | The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `document` | object | Yes | — | The document value | | `documentVariation` | object | Yes | — | Document Variation | | `id` | string | No | — | The globally unique identifier for the object. | | `queryType` | string | No | — | The type of the query that surfaced the document on which the feedback was given. | | `rating` | string | Yes | — | Feedback rating. | | `reason` | string | No | — | Feedback reason. | | `search` | object | No | — | The search value | | `selfUri` | string | No | — | The URI for this object | | `sessionId` | string | No | — | Knowledge guest session ID. | | `state` | string | No | — | The state of the feedback. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | | `userId` | string | No | — | The ID of the user who created the feedback. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "comment": { "type": "string", "description": "Free-text comment of the feedback. Maximum length: 2000 characters." }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Unknown", "Callback", "Chat", "Cobrowse", "Email", "Message", "Screenshare", "Video", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "dateCreated": { "type": "string", "description": "The date and time of the feedback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "document": { "type": "object", "description": "The document value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the document." }, "knowledgeBase": { "type": "object", "description": "Knowledge Base" }, "versionId": { "type": "string", "description": "The globally unique identifier for the version of the document." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "knowledgeBase", "versionId" ] }, "documentVariation": { "type": "object", "description": "Document Variation", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." } }, "required": [ "id" ] }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "queryType": { "type": "string", "description": "The type of the query that surfaced the document on which the feedback was given.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "rating": { "type": "string", "description": "Feedback rating.", "enum": [ "Negative", "Positive" ] }, "reason": { "type": "string", "description": "Feedback reason.", "enum": [ "DocumentContent", "SearchResults" ] }, "search": { "type": "object", "description": "The search value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." } }, "required": [ "id" ] }, "selfUri": { "type": "string", "description": "The URI for this object" }, "sessionId": { "type": "string", "description": "Knowledge guest session ID." }, "state": { "type": "string", "description": "The state of the feedback.", "enum": [ "Draft", "Final" ] }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] }, "userId": { "type": "string", "description": "The ID of the user who created the feedback." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "application", "document", "documentVariation", "rating" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_document\_variations Create a variation for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `body` | object | No | — | The body value | | `contexts` | object\[] | Yes | — | The context values associated with the variation. | | `dateCreated` | string | No | — | The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `dateModified` | string | No | — | The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `document` | object | No | — | The document value | | `documentVersion` | object | No | — | Document Version | | `id` | string | No | — | The globally unique identifier for the variation. | | `name` | string | No | — | The name of the variation. | | `priority` | integer | No | — | The priority of the variation. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "body": { "type": "object", "description": "The body value", "properties": { "blocks": { "type": "array", "items": { "type": "object" }, "description": "The list of building blocks for the document body." } }, "required": [ "blocks" ] }, "contexts": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "object", "description": "The context value" }, "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the knowledge context value." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "description": "The list of knowledge context values associated with the variation." } }, "required": [ "context", "values" ] }, "description": "The context values associated with the variation." }, "dateCreated": { "type": "string", "description": "The creation date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateModified": { "type": "string", "description": "The last modification date-time for the document variation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "document": { "type": "object", "description": "The document value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the document." }, "knowledgeBase": { "type": "object", "description": "Knowledge Base" }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "id", "knowledgeBase" ] }, "documentVersion": { "type": "object", "description": "Document Version", "properties": { "id": { "type": "string", "description": "The id value" }, "selfUri": { "type": "string", "description": "Self Uri" } } }, "id": { "type": "string", "description": "The globally unique identifier for the variation." }, "name": { "type": "string", "description": "The name of the variation." }, "priority": { "type": "integer", "description": "The priority of the variation." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "contexts" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_document\_versions Creates or restores a document version. **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Globally unique identifier for the knowledge base. | | `documentId` | string | Yes | — | Globally unique identifier for the document. | | `dateExpires` | string | No | — | Expiry date of document version, applicable only to the 'Archived' version of the document. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `datePublished` | string | No | — | Published date of document version. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss\[.mmm]Z | | `document` | object | No | — | The document value | | `id` | string | No | — | Globally unique identifier for the document version. | | `restoreFromVersionId` | string | Yes | — | The globally unique identifier for the document version. If the value is provided, the document is restored to the given version. If not, it publishes the draft changes as a new version of the document. | | `selfUri` | string | No | — | The URI for this object | | `versionNumber` | integer | No | — | Version Number of the document. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Globally unique identifier for the knowledge base." }, "documentId": { "type": "string", "description": "Globally unique identifier for the document." }, "dateExpires": { "type": "string", "description": "Expiry date of document version, applicable only to the 'Archived' version of the document. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "datePublished": { "type": "string", "description": "Published date of document version. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "document": { "type": "object", "description": "The document value", "properties": { "id": { "type": "string", "description": "The globally unique identifier for the object." }, "title": { "type": "string", "description": "Document title, having a limit of 500 words." }, "visible": { "type": "boolean", "description": "Indicates if the knowledge document should be included in search results." }, "alternatives": { "type": "array", "items": { "type": "object" }, "description": "List of alternate phrases related to the title which improves search results." }, "state": { "type": "string", "description": "State of the document.", "enum": [ "Draft", "Published", "Archived" ] }, "dateCreated": { "type": "string", "description": "Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateModified": { "type": "string", "description": "Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "dateImported": { "type": "string", "description": "Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "lastPublishedVersionNumber": { "type": "integer", "description": "The last published version number of the document." }, "datePublished": { "type": "string", "description": "The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, "createdBy": { "type": "object", "description": "Created By" }, "modifiedBy": { "type": "object", "description": "Modified By" }, "documentVersion": { "type": "object", "description": "Document Version" }, "category": { "type": "object", "description": "The category value" }, "labels": { "type": "array", "items": { "type": "object" }, "description": "The references to labels associated with the document." }, "knowledgeBase": { "type": "object", "description": "Knowledge Base" }, "externalId": { "type": "string", "description": "The reference to external id associated with the document." }, "externalUrl": { "type": "string", "description": "The URL to external document." }, "source": { "type": "object", "description": "The source value" }, "readonly": { "type": "boolean", "description": "Whether the document is read-only." }, "variations": { "type": "array", "items": { "type": "object" }, "description": "Variations of the document." }, "selfUri": { "type": "string", "description": "The URI for this object" } } }, "id": { "type": "string", "description": "Globally unique identifier for the document version." }, "restoreFromVersionId": { "type": "string", "description": "The globally unique identifier for the document version. If the value is provided, the document is restored to the given version. If not, it publishes the draft changes as a new version of the document." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "versionNumber": { "type": "integer", "description": "Version Number of the document." } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "restoreFromVersionId" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_document\_views Create view for a document. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `documentId` | string | Yes | — | Document ID. | | `application` | object | Yes | — | The application value | | `conversationContext` | object | No | — | Conversation Context | | `documentVariationId` | string | Yes | — | The variation of the viewed document. | | `documentVersionId` | string | Yes | — | The version of the viewed document. | | `queryType` | string | No | — | The type of the query that surfaced the document. | | `searchId` | string | No | — | The search that surfaced the viewed document. | | `sessionId` | string | No | — | The unique identifier of the knowledge session in which the document was viewed. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "documentId": { "type": "string", "description": "Document ID." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Unknown", "Callback", "Chat", "Cobrowse", "Email", "Message", "Screenshare", "Video", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "documentVariationId": { "type": "string", "description": "The variation of the viewed document." }, "documentVersionId": { "type": "string", "description": "The version of the viewed document." }, "queryType": { "type": "string", "description": "The type of the query that surfaced the document.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search that surfaced the viewed document." }, "sessionId": { "type": "string", "description": "The unique identifier of the knowledge session in which the document was viewed." }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "knowledgeBaseId", "documentId", "application", "documentVariationId", "documentVersionId" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_documents Create document. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `alternatives` | object\[] | No | — | List of alternate phrases related to the title which improves search results. | | `categoryId` | string | No | — | The category associated with the document. | | `externalId` | string | No | — | The external id associated with the document. | | `externalUrl` | string | No | — | The URL to external document. | | `id` | string | No | — | The globally unique identifier for the object. | | `labelIds` | string\[] | No | — | The ids of labels associated with the document. | | `selfUri` | string | No | — | The URI for this object | | `title` | string | Yes | — | Document title. | | `visible` | boolean | No | — | Indicates if the knowledge document should be included in search results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "alternatives": { "type": "array", "items": { "type": "object", "properties": { "phrase": { "type": "string", "description": "Alternate phrasing to the document title, having a limit of 500 words." }, "autocomplete": { "type": "boolean", "description": "Autocomplete enabled for the alternate phrase." } }, "required": [ "autocomplete", "phrase" ] }, "description": "List of alternate phrases related to the title which improves search results." }, "categoryId": { "type": "string", "description": "The category associated with the document." }, "externalId": { "type": "string", "description": "The external id associated with the document." }, "externalUrl": { "type": "string", "description": "The URL to external document." }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "labelIds": { "type": "array", "items": { "type": "string" }, "description": "The ids of labels associated with the document." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "title": { "type": "string", "description": "Document title." }, "visible": { "type": "boolean", "description": "Indicates if the knowledge document should be included in search results." } }, "required": [ "PCID", "knowledgeBaseId", "title" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_documents\_answers Answer documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `answerMode` | string\[] | No | — | Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight | | `appType` | string | No | — | The appType | | `insertHighlightIntoVariationContent` | boolean | No | — | If specified - insert highlight data into the variation content. | | `language` | string | No | — | The language of the documents. | | `query` | string | No | — | The search query. | | `queryType` | string | No | — | The query type | | `searchId` | string | No | — | The search id. | | `variationIds` | string\[] | Yes | — | The variation Ids to answer. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "answerMode": { "type": "array", "items": { "type": "string", "enum": [ "AnswerHighlight", "AnswerGeneration" ] }, "description": "Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight" }, "appType": { "type": "string", "description": "The appType", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "insertHighlightIntoVariationContent": { "type": "boolean", "description": "If specified - insert highlight data into the variation content." }, "language": { "type": "string", "description": "The language of the documents.", "enum": [ "en-US", "en-UK", "en-AU", "en-CA", "en-HK", "en-IN", "en-IE", "en-NZ", "en-PH", "en-SG", "en-ZA", "de-DE", "de-AT", "de-CH", "es-AR", "es-CO", "es-MX", "es-US", "es-ES", "fr-FR", "fr-BE", "fr-CA", "fr-CH", "pt-BR", "pt-PT", "nl-NL", "nl-BE", "it-IT", "ca-ES", "tr-TR", "sv-SE", "fi-FI", "nb-NO", "da-DK", "ja-JP", "ar-AE", "zh-CN", "zh-TW", "zh-HK", "ko-KR", "pl-PL", "hi-IN", "th-TH", "hu-HU", "vi-VN", "uk-UA", "cs-CZ", "fil-PH", "ms-MY", "he-IL", "el-GR" ] }, "query": { "type": "string", "description": "The search query." }, "queryType": { "type": "string", "description": "The query type", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search id." }, "variationIds": { "type": "array", "items": { "type": "string" }, "description": "The variation Ids to answer." } }, "required": [ "PCID", "knowledgeBaseId", "variationIds" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_documents\_presentations Indicate that documents were presented to the user. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID. | | `application` | object | Yes | — | The application value | | `conversationContext` | object | No | — | Conversation Context | | `documents` | object\[] | Yes | — | The presented documents | | `queryType` | string | No | — | The type of the query that surfaced the documents. | | `searchId` | string | No | — | The search that surfaced the documents that were presented. | | `sessionId` | string | No | — | Knowledge session ID. | | `surfacingMethod` | string | No | — | The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Unknown", "Callback", "Chat", "Cobrowse", "Email", "Message", "Screenshare", "Video", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "description": "The ID of the document." }, "documentVariationId": { "type": "string", "description": "The variation of the document." }, "documentVersionId": { "type": "string", "description": "The version of the document." }, "surfacingMethod": { "type": "string", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ], "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown." } }, "required": [ "documentId", "documentVariationId", "documentVersionId" ] }, "description": "The presented documents" }, "queryType": { "type": "string", "description": "The type of the query that surfaced the documents.", "enum": [ "Unknown", "Article", "AutoSearch", "Category", "ManualSearch", "Recommendation", "Suggestion", "ExpandedArticle" ] }, "searchId": { "type": "string", "description": "The search that surfaced the documents that were presented." }, "sessionId": { "type": "string", "description": "Knowledge session ID." }, "surfacingMethod": { "type": "string", "description": "The method how knowledge was surfaced. Article: Full article was shown. Snippet: A snippet from the article was shown. Highlight: A highlighted answer in a snippet was shown.Generative: A generated answer in a snippet was shown.", "enum": [ "Unknown", "Article", "Snippet", "Highlight", "Generative" ] } }, "required": [ "PCID", "knowledgeBaseId", "application", "documents" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_documents\_query Query for knowledge documents. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge Base ID | | `expand` | string\[] | No | — | Fields, if any, to expand for each document in the search result matching the query. | | `filter` | object | Yes | — | The filter value | | `includeDraftDocuments` | boolean | No | — | Indicates whether the results would also include draft documents. | | `includeVariations` | string | No | — | Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All. | | `interval` | object | No | — | The interval value | | `pageNumber` | integer | No | — | Page number of the returned results. | | `pageSize` | integer | No | — | Page size of the returned results. | | `sortBy` | string | No | — | The field in the documents that you want to sort the results by. | | `sortOrder` | string | No | — | The sort order for results. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge Base ID" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "documentVariations", "documentAlternatives", "knowledgeBaseLanguageCode", "variationChunks" ] }, "description": "Fields, if any, to expand for each document in the search result matching the query." }, "filter": { "type": "object", "description": "The filter value", "properties": { "clauses": { "type": "array", "items": { "type": "object" }, "description": "Documents filter clauses/criteria. Limit of 20 clauses." }, "operator": { "type": "string", "description": "Specifies how the filter clauses will be applied together.", "enum": [ "Or", "And" ] } }, "required": [ "clauses", "operator" ] }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the results would also include draft documents." }, "includeVariations": { "type": "string", "description": "Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.", "enum": [ "All", "AllMatching", "SingleMostRelevant" ] }, "interval": { "type": "object", "description": "The interval value", "properties": { "field": { "type": "string", "description": "Specifies the date field to be used for date and time range.", "enum": [ "dateCreated", "dateModified", "datePublished" ] }, "value": { "type": "string", "description": "Specifies the date and time range for filtering the documents. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" } } }, "pageNumber": { "type": "integer", "description": "Page number of the returned results." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "sortBy": { "type": "string", "description": "The field in the documents that you want to sort the results by.", "enum": [ "DateCreated", "DateModified", "CategoryName", "LabelName", "ViewCount" ] }, "sortOrder": { "type": "string", "description": "The sort order for results.", "enum": [ "Asc", "Desc" ] } }, "required": [ "PCID", "knowledgeBaseId", "filter" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_documents\_search Search the documents in a knowledge base. **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | The ID of knowledge base containing the documents to query. | | `expand` | string\[] | No | — | Fields, if any, to expand for each document in the search result matching the query. | | `answerHighlightTopResults` | integer | No | — | The number of articles to be sent for answer-highlighting. Can range from 1-5. | | `answerMode` | string\[] | No | — | Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults. | | `application` | object | No | — | The application value | | `confidenceThreshold` | number | No | — | The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1. | | `conversationContext` | object | No | — | Conversation Context | | `filter` | object | No | — | The filter value | | `includeDraftDocuments` | boolean | No | — | Indicates whether the search results would also include draft documents. | | `interval` | object | No | — | The interval value | | `pageCount` | integer | No | — | Number of pages returned in the result calculated according to the pageSize and the total | | `pageNumber` | integer | No | — | Page number of the returned results. | | `pageSize` | integer | No | — | Page size of the returned results. | | `preprocessQuery` | boolean | No | — | Indicates whether the search query should be preprocessed. | | `query` | string | Yes | — | Query to search content in the knowledge base. Maximum of 30 records per query can be fetched. | | `queryType` | string | No | — | The type of the query that initiates the search. | | `searchId` | string | No | — | The globally unique identifier for the search. | | `sortBy` | string | No | — | The field in the documents that you want to sort the search results by. | | `sortOrder` | string | No | — | The sort order for search results. | | `total` | integer | No | — | The total number of documents matching the query. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "The ID of knowledge base containing the documents to query." }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "documentVariations", "documentAlternatives", "knowledgeBaseLanguageCode", "variationChunks" ] }, "description": "Fields, if any, to expand for each document in the search result matching the query." }, "answerHighlightTopResults": { "type": "integer", "description": "The number of articles to be sent for answer-highlighting. Can range from 1-5." }, "answerMode": { "type": "array", "items": { "type": "string", "enum": [ "AnswerHighlight", "AnswerGeneration" ] }, "description": "Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults." }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "Assistant", "BotFlow", "MessengerKnowledgeApp", "SmartAdvisor", "SupportCenter" ] }, "deployment": { "type": "object", "description": "The deployment value" }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "confidenceThreshold": { "type": "number", "description": "The confidence threshold for the search results. If applied, the returned results will have an equal or higher confidence than the threshold. The value should be between 0 to 1." }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Unknown", "Callback", "Chat", "Cobrowse", "Email", "Message", "Screenshare", "Video", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "filter": { "type": "object", "description": "The filter value", "properties": { "clauses": { "type": "array", "items": { "type": "object" }, "description": "Documents filter clauses/criteria. Limit of 20 clauses." }, "operator": { "type": "string", "description": "Specifies how the filter clauses will be applied together.", "enum": [ "Or", "And" ] } }, "required": [ "clauses", "operator" ] }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the search results would also include draft documents." }, "interval": { "type": "object", "description": "The interval value", "properties": { "field": { "type": "string", "description": "Specifies the date field to be used for date and time range.", "enum": [ "dateCreated", "dateModified", "datePublished" ] }, "value": { "type": "string", "description": "Specifies the date and time range for filtering the documents. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" } } }, "pageCount": { "type": "integer", "description": "Number of pages returned in the result calculated according to the pageSize and the total" }, "pageNumber": { "type": "integer", "description": "Page number of the returned results." }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "preprocessQuery": { "type": "boolean", "description": "Indicates whether the search query should be preprocessed." }, "query": { "type": "string", "description": "Query to search content in the knowledge base. Maximum of 30 records per query can be fetched." }, "queryType": { "type": "string", "description": "The type of the query that initiates the search.", "enum": [ "AutoSearch", "ManualSearch", "Suggestion" ] }, "searchId": { "type": "string", "description": "The globally unique identifier for the search." }, "sortBy": { "type": "string", "description": "The field in the documents that you want to sort the search results by.", "enum": [ "ConfidenceScore", "DateCreated", "DateModified", "CategoryName", "LabelName" ] }, "sortOrder": { "type": "string", "description": "The sort order for search results.", "enum": [ "Asc", "Desc" ] }, "total": { "type": "integer", "description": "The total number of documents matching the query." } }, "required": [ "PCID", "knowledgeBaseId", "query" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_documents\_search\_suggestions Query the knowledge documents to provide suggestions for auto completion. **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | The ID of knowledge base containing the documents to query. | | `filter` | object | No | — | The filter value | | `includeDraftDocuments` | boolean | No | — | Indicates whether the suggestion results would also include draft documents. | | `interval` | object | No | — | The interval value | | `pageSize` | integer | No | — | Page size of the returned results. | | `query` | string | Yes | — | Query to get autocomplete suggestions for the matching knowledge documents. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "The ID of knowledge base containing the documents to query." }, "filter": { "type": "object", "description": "The filter value", "properties": { "clauses": { "type": "array", "items": { "type": "object" }, "description": "Documents filter clauses/criteria. Limit of 20 clauses." }, "operator": { "type": "string", "description": "Specifies how the filter clauses will be applied together.", "enum": [ "Or", "And" ] } }, "required": [ "clauses", "operator" ] }, "includeDraftDocuments": { "type": "boolean", "description": "Indicates whether the suggestion results would also include draft documents." }, "interval": { "type": "object", "description": "The interval value", "properties": { "field": { "type": "string", "description": "Specifies the date field to be used for date and time range.", "enum": [ "dateCreated", "dateModified", "datePublished" ] }, "value": { "type": "string", "description": "Specifies the date and time range for filtering the documents. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss" } } }, "pageSize": { "type": "integer", "description": "Page size of the returned results." }, "query": { "type": "string", "description": "Query to get autocomplete suggestions for the matching knowledge documents." } }, "required": [ "PCID", "knowledgeBaseId", "query" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_labels Create new label **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ---------------------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `color` | string | Yes | — | The color for the label. | | `externalId` | string | No | — | The external id associated with the label. | | `id` | string | No | — | The globally unique identifier for the object. | | `name` | string | Yes | — | The name of the label. | | `selfUri` | string | No | — | The URI for this object | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "color": { "type": "string", "description": "The color for the label." }, "externalId": { "type": "string", "description": "The external id associated with the label." }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "name": { "type": "string", "description": "The name of the label." }, "selfUri": { "type": "string", "description": "The URI for this object" } }, "required": [ "PCID", "knowledgeBaseId", "color", "name" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_parse\_jobs Create parse job **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | --------- | -------- | ------- | ----------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `hints` | string\[] | No | — | Hinted titles for the parser. | | `uploadKey` | string | Yes | — | Upload key | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "hints": { "type": "array", "items": { "type": "string" }, "description": "Hinted titles for the parser." }, "uploadKey": { "type": "string", "description": "Upload key" } }, "required": [ "PCID", "knowledgeBaseId", "uploadKey" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_sources\_salesforce Create Salesforce Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `id` | string | No | — | The globally unique identifier for the object. | | `integrationId` | string | No | — | The integration associated with the source. | | `name` | string | Yes | — | The name of the integration source. | | `schedulePeriod` | integer | No | — | The schedule period of the source in hours. Must be at least 6 and at most 48 hours. | | `selfUri` | string | No | — | The URI for this object | | `settings` | object | No | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "integrationId": { "type": "string", "description": "The integration associated with the source." }, "name": { "type": "string", "description": "The name of the integration source." }, "schedulePeriod": { "type": "integer", "description": "The schedule period of the source in hours. Must be at least 6 and at most 48 hours." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "settings": { "type": "object", "description": "The settings value", "properties": { "channel": { "type": "string", "description": "Filter source by channel.", "enum": [ "App", "Pkb", "Csp", "Prm" ] }, "language": { "type": "string", "description": "Filter source by language." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Filter source by categories." }, "baseUrl": { "type": "string", "description": "The base URL to resources." } } } }, "required": [ "PCID", "knowledgeBaseId", "name" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_sources\_salesforce\_source\_id\_sync Start sync on Salesforce Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" } }, "required": [ "PCID", "knowledgeBaseId", "sourceId" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_sources\_servicenow Create ServiceNow Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `id` | string | No | — | The globally unique identifier for the object. | | `integrationId` | string | No | — | The integration associated with the source. | | `name` | string | Yes | — | The name of the integration source. | | `schedulePeriod` | integer | No | — | The schedule period of the source in hours. Must be at least 6 and at most 48 hours. | | `selfUri` | string | No | — | The URI for this object | | `settings` | object | No | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "integrationId": { "type": "string", "description": "The integration associated with the source." }, "name": { "type": "string", "description": "The name of the integration source." }, "schedulePeriod": { "type": "integer", "description": "The schedule period of the source in hours. Must be at least 6 and at most 48 hours." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "settings": { "type": "object", "description": "The settings value", "properties": { "knowledgeBaseIds": { "type": "array", "items": { "type": "string" }, "description": "Filter source by knowledge base ids." }, "language": { "type": "string", "description": "Filter source by language." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Filter source by categories." }, "baseUrl": { "type": "string", "description": "The base URL to resources." } } } }, "required": [ "PCID", "knowledgeBaseId", "name" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_sources\_servicenow\_source\_id\_sync Start synchronization on ServiceNow Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ----------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" } }, "required": [ "PCID", "knowledgeBaseId", "sourceId" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_synchronize\_jobs Create synchronization job **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | -------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | No | — | Knowledge integration source id. | | `uploadKey` | string | Yes | — | Upload key | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Knowledge integration source id." }, "uploadKey": { "type": "string", "description": "Upload key" } }, "required": [ "PCID", "knowledgeBaseId", "uploadKey" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebase\_uploads\_urls\_jobs Create content upload from URL job **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | --------------------------------- | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `uploadUrl` | string | Yes | — | The URL of the content to upload. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "uploadUrl": { "type": "string", "description": "The URL of the content to upload." } }, "required": [ "PCID", "knowledgeBaseId", "uploadUrl" ] } ``` *** ## genesys\_knowledge\_post\_knowledgebases Create new knowledge base **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `contentSearchEnabled` | boolean | No | — | Flag that indicates the search on content is enabled for the knowledge base. | | `coreLanguage` | string | Yes | — | Core language for knowledge base in which initial content must be created, language codes \[en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes \[ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA] which might have a lower accuracy. | | `description` | string | No | — | Knowledge base description | | `name` | string | Yes | — | Knowledge base name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "contentSearchEnabled": { "type": "boolean", "description": "Flag that indicates the search on content is enabled for the knowledge base." }, "coreLanguage": { "type": "string", "description": "Core language for knowledge base in which initial content must be created, language codes [en-US, en-UK, en-AU, de-DE] are supported currently. However, the new DX knowledge will support all these language codes, along with 'early preview' language codes [ca-ES, tr-TR, sv-SE, fi-FI, nb-NO, da-DK, ja-JP, ar-AE, zh-CN, zh-TW, zh-HK, ko-KR, pl-PL, hi-IN, th-TH, hu-HU, vi-VN, uk-UA] which might have a lower accuracy.", "enum": [ "en-US", "en-UK", "en-AU", "en-CA", "en-HK", "en-IN", "en-IE", "en-NZ", "en-PH", "en-SG", "en-ZA", "de-DE", "de-AT", "de-CH", "es-AR", "es-CO", "es-MX", "es-US", "es-ES", "fr-FR", "fr-BE", "fr-CA", "fr-CH", "pt-BR", "pt-PT", "nl-NL", "nl-BE", "it-IT", "ca-ES", "tr-TR", "sv-SE", "fi-FI", "nb-NO", "da-DK", "ja-JP", "ar-AE", "zh-CN", "zh-TW", "zh-HK", "ko-KR", "pl-PL", "hi-IN", "th-TH", "hu-HU", "vi-VN", "uk-UA", "cs-CZ", "fil-PH", "ms-MY", "he-IL", "el-GR" ] }, "description": { "type": "string", "description": "Knowledge base description" }, "name": { "type": "string", "description": "Knowledge base name" } }, "required": [ "PCID", "coreLanguage", "name" ] } ``` *** ## genesys\_knowledge\_post\_search Get Knowledge Search **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | ------------------------------------------------------- | | `application` | object | No | — | The application value | | `conversationContext` | object | No | — | Conversation Context | | `conversationTurns` | object\[] | No | — | List of conversation turns to use for stateful search. | | `generationLanguage` | string | No | — | The language to use for answer generation. | | `knowledgeSettingId` | string | Yes | — | Knowledge Setting Id to use for search request. | | `query` | string | Yes | — | Input query to search content on the knowledge setting. | | `queryType` | string | No | — | The type of the query that initiates the search. | | `sessionId` | string | No | — | The session id for search request. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "Application type.", "enum": [ "BotFlow", "SmartAdvisor" ] }, "botFlow": { "type": "object", "description": "Bot Flow" }, "assistant": { "type": "object", "description": "The assistant value" } }, "required": [ "type" ] }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "conversationId": { "type": "string", "description": "The unique identifier of the conversation." }, "mediaType": { "type": "string", "description": "The media type of the conversation.", "enum": [ "Call", "Chat", "Email", "Message", "Voice" ] }, "messageType": { "type": "string", "description": "The message type of the conversation.", "enum": [ "Unknown", "Phone", "SMS", "GenesysChatWidget", "FacebookMessenger", "WeChat", "Whatsapp", "AppleBusinessChat", "Telegram", "Slack", "Signal", "Line", "Discord", "TwitterDirectMessage", "Other", "Open", "Instagram", "Apple" ] }, "queueId": { "type": "string", "description": "The unique identifier of the queue used to assign the interaction to the user." }, "externalContactId": { "type": "string", "description": "The external contact identifier of the end-user participant." } }, "required": [ "conversationId" ] }, "conversationTurns": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "enum": [ "External", "Internal" ], "description": "The participant type." }, "text": { "type": "string", "description": "The message text." } } }, "description": "List of conversation turns to use for stateful search." }, "generationLanguage": { "type": "string", "description": "The language to use for answer generation.", "enum": [ "ar-AE", "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-PH", "en-SG", "en-US", "en-ZA", "es-AR", "es-CO", "es-ES", "es-MX", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "hu-HU", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "el-GR", "fil-PH", "he-IL", "ms-MY", "pl-PL", "th-TH" ] }, "knowledgeSettingId": { "type": "string", "description": "Knowledge Setting Id to use for search request." }, "query": { "type": "string", "description": "Input query to search content on the knowledge setting." }, "queryType": { "type": "string", "description": "The type of the query that initiates the search.", "enum": [ "AutoSearch", "ManualSearch" ] }, "sessionId": { "type": "string", "description": "The session id for search request." } }, "required": [ "PCID", "knowledgeSettingId", "query" ] } ``` *** ## genesys\_knowledge\_post\_search\_preview Get Knowledge Search Preview **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------- | | `application` | object | No | — | The application value | | `conversationContext` | object | No | — | Conversation Context | | `conversationTurns` | object\[] | No | — | List of conversation turns to use for stateful search. | | `filter` | object | No | — | The filter value | | `generationSetting` | object | Yes | — | Generation Setting | | `query` | string | Yes | — | Query to search content in the knowledge sources. | | `sources` | object\[] | Yes | — | Source information to search upon. | | `stateful` | boolean | No | — | Indicates if stateful search and generation is enabled for the knowledge setting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "application": { "type": "object", "description": "The application value", "properties": { "type": { "type": "string", "description": "The application type to simulate for the preview.", "enum": [ "BotFlow", "SmartAdvisor" ] } }, "required": [ "type" ] }, "conversationContext": { "type": "object", "description": "Conversation Context", "properties": { "mediaType": { "type": "string", "description": "The media type to simulate for the preview.", "enum": [ "Voice", "Message" ] } }, "required": [ "mediaType" ] }, "conversationTurns": { "type": "array", "items": { "type": "object", "properties": { "participant": { "type": "string", "enum": [ "External", "Internal" ], "description": "The participant type." }, "text": { "type": "string", "description": "The message text." } } }, "description": "List of conversation turns to use for stateful search." }, "filter": { "type": "object", "description": "The filter value", "properties": { "allOf": { "type": "array", "items": { "type": "string" }, "description": "Tags that must all be present (AND)." }, "anyOfGroups": { "type": "array", "items": { "type": "array" }, "description": "OR groups ANDed together; within each group at least one tag must match." }, "noneOf": { "type": "array", "items": { "type": "string" }, "description": "Tags that must not be present on matching chunks." } } }, "generationSetting": { "type": "object", "description": "Generation Setting", "properties": { "answerGeneration": { "type": "boolean", "description": "Indicates if answer generation is enabled for the setting." }, "generationLanguage": { "type": "string", "description": "Answer generation language.", "enum": [ "ar-AE", "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-PH", "en-SG", "en-US", "en-ZA", "es-AR", "es-CO", "es-ES", "es-MX", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "hu-HU", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "el-GR", "fil-PH", "he-IL", "ms-MY", "pl-PL", "th-TH" ] } }, "required": [ "answerGeneration" ] }, "query": { "type": "string", "description": "Query to search content in the knowledge sources." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Source Id." }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } }, "required": [ "id" ] }, "description": "Source information to search upon." }, "stateful": { "type": "boolean", "description": "Indicates if stateful search and generation is enabled for the knowledge setting." } }, "required": [ "PCID", "generationSetting", "query", "sources" ] } ``` *** ## genesys\_knowledge\_post\_settings Create Knowledge setting. **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------- | | `description` | string | No | — | Knowledge setting description. | | `filter` | object | No | — | The filter value | | `generationSetting` | object | No | — | Generation Setting | | `name` | string | Yes | — | Knowledge setting name. | | `sources` | object\[] | Yes | — | Knowledge source information to search upon. | | `stateful` | boolean | No | — | Indicates if stateful search and generation is enabled for the knowledge setting. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "description": { "type": "string", "description": "Knowledge setting description." }, "filter": { "type": "object", "description": "The filter value", "properties": { "allOf": { "type": "array", "items": { "type": "string" }, "description": "Tags that must all be present (AND)." }, "anyOfGroups": { "type": "array", "items": { "type": "array" }, "description": "OR groups ANDed together; within each group at least one tag must match." }, "noneOf": { "type": "array", "items": { "type": "string" }, "description": "Tags that must not be present on matching chunks." } } }, "generationSetting": { "type": "object", "description": "Generation Setting", "properties": { "answerGeneration": { "type": "boolean", "description": "Indicates if answer generation is enabled for the setting." }, "generationLanguage": { "type": "string", "description": "Answer generation language.", "enum": [ "ar-AE", "cs-CZ", "da-DK", "de-AT", "de-CH", "de-DE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IN", "en-NZ", "en-PH", "en-SG", "en-US", "en-ZA", "es-AR", "es-CO", "es-ES", "es-MX", "es-US", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "hu-HU", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-BE", "nl-NL", "pt-BR", "pt-PT", "sv-SE", "tr-TR", "el-GR", "fil-PH", "he-IL", "ms-MY", "pl-PL", "th-TH" ] } }, "required": [ "answerGeneration" ] }, "name": { "type": "string", "description": "Knowledge setting name." }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Source Id." }, "selfUri": { "type": "string", "format": "uri", "description": "The URI for this object" } }, "required": [ "id" ] }, "description": "Knowledge source information to search upon." }, "stateful": { "type": "boolean", "description": "Indicates if stateful search and generation is enabled for the knowledge setting." } }, "required": [ "PCID", "name", "sources" ] } ``` *** ## genesys\_knowledge\_put\_knowledgebase\_sources\_salesforce\_source\_id Update Salesforce Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | | `id` | string | No | — | The globally unique identifier for the object. | | `integrationId` | string | No | — | The integration associated with the source. | | `name` | string | Yes | — | The name of the integration source. | | `schedulePeriod` | integer | No | — | The schedule period of the source in hours. Must be at least 6 and at most 48 hours. | | `selfUri` | string | No | — | The URI for this object | | `settings` | object | No | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "integrationId": { "type": "string", "description": "The integration associated with the source." }, "name": { "type": "string", "description": "The name of the integration source." }, "schedulePeriod": { "type": "integer", "description": "The schedule period of the source in hours. Must be at least 6 and at most 48 hours." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "settings": { "type": "object", "description": "The settings value", "properties": { "channel": { "type": "string", "description": "Filter source by channel.", "enum": [ "App", "Pkb", "Csp", "Prm" ] }, "language": { "type": "string", "description": "Filter source by language." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Filter source by categories." }, "baseUrl": { "type": "string", "description": "The base URL to resources." } } } }, "required": [ "PCID", "knowledgeBaseId", "sourceId", "name" ] } ``` *** ## genesys\_knowledge\_put\_knowledgebase\_sources\_servicenow\_source\_id Update ServiceNow Knowledge integration source **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ | | `knowledgeBaseId` | string | Yes | — | Knowledge base ID | | `sourceId` | string | Yes | — | Source ID | | `id` | string | No | — | The globally unique identifier for the object. | | `integrationId` | string | No | — | The integration associated with the source. | | `name` | string | Yes | — | The name of the integration source. | | `schedulePeriod` | integer | No | — | The schedule period of the source in hours. Must be at least 6 and at most 48 hours. | | `selfUri` | string | No | — | The URI for this object | | `settings` | object | No | — | The settings value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID" }, "sourceId": { "type": "string", "description": "Source ID" }, "id": { "type": "string", "description": "The globally unique identifier for the object." }, "integrationId": { "type": "string", "description": "The integration associated with the source." }, "name": { "type": "string", "description": "The name of the integration source." }, "schedulePeriod": { "type": "integer", "description": "The schedule period of the source in hours. Must be at least 6 and at most 48 hours." }, "selfUri": { "type": "string", "description": "The URI for this object" }, "settings": { "type": "object", "description": "The settings value", "properties": { "knowledgeBaseIds": { "type": "array", "items": { "type": "string" }, "description": "Filter source by knowledge base ids." }, "language": { "type": "string", "description": "Filter source by language." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Filter source by categories." }, "baseUrl": { "type": "string", "description": "The base URL to resources." } } } }, "required": [ "PCID", "knowledgeBaseId", "sourceId", "name" ] } ```