afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/GenAIConversationSummary.json

56 lines
3.1 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"associated_objects"
],
"title": "GenAIConversationSummary - Data API",
"description": "Represents a generated summary of a voice or video call. This object is available in API version 60.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"ConversationRecordId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The unique ID of the related voice or video call record. This field is a polymorphic relationship field.",
"relationship_name": "ConversationRecord",
"relationship_type": "Master-detail",
"refers_to": "VideoCall, VoiceCall (the master object)"
},
"CurrencyIsoCode": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization. Possible values are: MXN—Mexican Peso USD—U.S. Dollar The default value is USD."
},
"ErrorMessage": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "An error message when there is a problem with sharing the conversation summary."
},
"Source": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "Whether the summary shown is content generated by Einstein or subsequently edited by a user. Possible values are: EINSTEIN_GPT—Einstein USER_EDITED—User Edited"
},
"Status": {
"type": "picklist",
"properties": "Filter, Group, Restricted picklist, Sort, Update",
"description": "The status of the summary. Possible values are: ERROR—Error GENERATING—Generating SUCCESS—Success"
},
"Summary": {
"type": "textarea",
"properties": "Create, Nillable, Update",
"description": "The summary text content."
}
},
"special_access_rules": "To access this object, Einstein Conversation Insights and Einstein for Sales must be enabled in your org.\n\nTo access this object, Einstein Conversation\n Insights and Einstein for Sales must be enabled in your\n org.",
"associated_objects": "This object has the following associated objects. If the API version isnt specified, theyre available in the same API versions as this object. Otherwise, theyre available in the specified API version and later.\n\n- **GenAIConversationSummaryChangeEvent**: Change events are available for the object.\n- **GenAIConversationSummaryFeed**: Feed tracking is available for the object.\n- **GenAIConversationSummaryHistory**: History is available for tracked fields of the object.\n- **GenAIConversationSummaryOwnerSharingRule**: Sharing rules are available for the object.\n- **GenAIConversationSummaryShare**: Sharing is available for the object."
}