Generative AI API Endpoint Details

each of the generative ai endpoints utilize the unique interactionidentifier returned upon successful declaration of the audio https //docs elevateai com/tutorials/declare an audio interaction , transcript https //docs elevateai com/tutorials/declare a transcript , or chat https //docs elevateai com/tutorials/declare a chat interaction interaction note audio interactions must have completed processing before the generative ai endpoints can provide success responses attempting to make a request prior to the completed processing of an audio interaction will result in an error response chats and transcripts allow for immediate access to generative ai end points after declaration the generative ai rest api calls are all similar in format for details on that format, please see the making api requests for generative ai results docid\ tmvsglcj4mong8o56 f3c page unsuccessful response codes are documented on that page as well following is a guide to using these features // // cx generative ai api features summary description retrieves a summary of the interaction between the agent and customer endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/summary gen ai/cx/summary successful response { "summary" string } summary details description summarizes additional details about the interaction, including the reason(s) for the interaction, actions taken, entities mentioned, and whether or not a resolution was reached endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/summary/details gen ai/cx/summary/details successful response { "reasons" string\[], "actionstakenbyagent" string\[], "entities" \[{ "type" string, "value" string }], "isresolved" boolean } agent action items description provides insight into the specific actions taken by an agent over the course of a customer interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/agent/action items gen ai/cx/agent/action items successful response \[{ "action" string, "details" string }] agent coaching assistant description provides insight into agent behaviors throughout an interaction, allowing users to identify opportunities for agent coaching and/or agent improvement after a customer interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/agent/coaching assistant gen ai/cx/agent/coaching assistant successful response { "coaching" string } topics description provides a list of the topics that were discussed during the interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/topics gen ai/cx/topics successful response \[{ "topic" string, "description" string }] conversation composition description provides a list of the questions and/or concerns that were raised by the customer during an interaction, the steps used to address and/or resolve each issue, and the status of each issue, post interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/conversation composition gen ai/cx/conversation composition successful response \[{ "concernsummary" string, "concern" string, "isresolved" boolean, "actionstakenbyagent" string\[] }] ask elevateai q\&a description allows user to ask questions around a specific interaction – up to 5 questions, in up to 30 words – and receive specific answers data queried is your data! a single question (up to 2000 characters) is asked in the request body of the post method the answer to the question is returned in the response up to a maximum of 5 successful questions or 5 error responses are allowed per interaction this endpoint also supports a get method which returns all of the prior question & answer pairs for this interaction (including failed questions and responses) endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/cx/ask gen ai/cx/ask post request body { "question" "\<enter your question here>" } post successful response \[{ "question" string, "answer" string }] get successful response \[{ "question" string, "answer" string }, { "question" string, "answer" string }, { "question" string, "answer" string }] // // generic (non cx) generative ai api features summary description retrieves a summary of the interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/summary gen ai/summary successful response { "summary" string } summary details description summarizes the entities mentioned within the interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/summary/details gen ai/summary/details successful response { "entities" \[{ "type" string, "value" string }] } action items description describes the action items which were raised during the interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/action items gen ai/action items successful response \[{ "action" string, "details" string }] topics description returns a list of topics that were discussed during the interaction endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/topics gen ai/topics successful response \[{ "topic" string, "description" string }] ask elevateai description allows you to ask questions about an interaction a single question (up to 250 characters) is asked in the request body of the post method the answer to the question is returned in the response up to a maximum of 5 successful questions or 5 error responses are allowed per interaction this endpoint also supports a get method which returns all of the prior question & answer pairs for this interaction (including failed questions and responses) endpoint /v1/interactions/{interactionidentifier\ guid}/ gen ai/ask gen ai/ask post request body { "question" "\<enter your question here>" } post successful response \[{ "question" string, "answer" string }] get successful response \[{ "question" string, "answer" string }, { "question" string, "answer" string }, { "question" string, "answer" string }] for any further assistance or inquiries, please contact our support team here