openapi: 3.0.0 info: title: Partner Configuration API description: > This is the Partner Configuration API which allows ASAPP partners to manage configurations. Currently we are offering: - Custom Vocabularies: API endpoints to create, delete, update, and retrieve custom vocabularies. - Redaction Entities: API endpoints to update and retrieve redaction entities. - Structured Data Fields: API endpoints to create, delete, update, and retrieve structured data fields. Important Note: Custom Vocabularies and Redaction Entities do not support concurrent operations within the same category. You can perform updates, creations or deletes concurrently between Custom Vocabularies and Redaction Entities, but not within each one. Each operation may take up to 45 seconds to complete. version: 1.0.0 servers: - url: https://api.sandbox.asapp.com security: - API-ID: [] API-Secret: [] tags: - name: Configuration description: Operations to manage ASAPP configurations paths: /configuration/v1/custom-vocabularies: get: tags: - Configuration summary: List custom vocabularies parameters: - in: query name: cursor schema: type: string nullable: true description: The cursor pointing to the current position - in: query name: limit schema: type: integer nullable: true minimum: 1 maximum: 100 default: 20 description: The maximum amount of objects to retrieve description: | Retrieves all custom vocabulary configurations. operationId: getCustomVocabularyConfigurations responses: '200': description: Custom vocabulary configurations. content: application/json: schema: type: object properties: customVocabularies: type: array items: description: A list of custom vocabularies. example: id: '1' phrase: IEEE soundsLike: - I triple E type: object allOf: - type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: >- An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E - type: object properties: id: type: string description: The id of the custom vocabulary nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - customVocabularies - nextCursor - prevCursor '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message post: tags: - Configuration summary: Create a custom vocabulary description: > Creates a new custom vocabulary configuration to improve transcription accuracy. Custom vocabularies are used to enhance speech-to-text transcription by providing: - Specific phrases that are commonly used in your domain - Phonetic representations ("sounds like") to help the system recognize these phrases For example, you might define: - Phrase: "IEEE" - Sounds Like: ["I triple E"] This helps the system correctly transcribe technical terms, brand names, or industry-specific terminology. The API returns immediately, but the transcription service can take up to 1 minute to incorporate the custom vocabulary change. operationId: postCustomVocabularyConfiguration requestBody: required: true content: application/json: schema: type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. example: I triple E soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string example: IEEE required: - phrase - soundsLike example: phrase: I triple E soundsLike: - IEEE responses: '201': description: Custom vocabulary created. content: application/json: schema: type: object allOf: - type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E - type: object properties: id: type: string description: The id of the custom vocabulary '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/custom-vocabularies/{customVocabularyId}: parameters: - name: customVocabularyId description: Identifier of the custom vocabulary in: path required: true schema: type: string get: tags: - Configuration summary: Retrieve a custom vocabulary description: | Get a custom vocabulary configuration operationId: getCustomVocabularyConfiguration responses: '200': description: Returns the custom vocabulary content: application/json: schema: type: object allOf: - type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E - type: object properties: id: type: string description: The id of the custom vocabulary '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message delete: tags: - Configuration summary: Delete a custom vocabulary description: | Deletes a custom vocabulary configuration operationId: deleteCustomVocabularyConfiguration responses: '200': description: Deletes custom vocabulary '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/redaction-entities: get: tags: - Configuration summary: List redaction entities parameters: - in: query name: cursor schema: type: string nullable: true description: The cursor pointing to the current position - in: query name: limit schema: type: integer nullable: true minimum: 1 maximum: 100 default: 20 description: The maximum amount of objects to retrieve operationId: listRedactionEntities description: > Lists all available redaction entities and their current activation status across different policies. Redaction entities represent different types of sensitive information that can be automatically redacted from conversations. Each entity can be independently enabled or disabled for different redaction policies: - Customer Immediate: Redaction in real-time for customer-facing content - Customer Delayed: Redaction for stored customer-facing content - Agent Immediate: Real-time redaction for agent-facing content - Auto Transcribe: Redaction in transcription output - Voice: Redaction in voice content The API returns immediately, but the redaction service can take up to 1 minute to incorporate the redaction change. responses: '200': description: Successfully retrieved the redaction entities. content: application/json: schema: type: object properties: redactionEntities: type: array description: The list of redaction entities items: type: object properties: id: type: string description: The id of the redaction entity example: CREDIT_CARD_NUMBER description: type: string description: The description of the redaction entity example: '' policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - id - description - policies example: id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - redactionEntities - nextCursor - prevCursor example: redactionEntities: - id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false nextCursor: CVV prevCursor: PHONE_NUMBER '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/redaction-entities/{entityId}: parameters: - name: entityId description: Identifier of the entity in: path required: true schema: type: string get: tags: - Configuration summary: Retrieve a redaction entity operationId: getRedactionEntity description: | Get a specific redaction entity with a entity id responses: '200': description: Successfully retrieved the redaction entity. content: application/json: schema: type: object properties: id: type: string description: The id of the redaction entity example: CREDIT_CARD_NUMBER description: type: string description: The description of the redaction entity example: '' policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - id - description - policies example: id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message patch: tags: - Configuration summary: Update a redaction entity operationId: updateRedactionEntity description: > Update the policies of a specific redaction entity. Only the policies field can be modified. requestBody: required: true content: application/json: schema: type: object properties: policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - policies example: policies: customerImmediate: false customerDelayed: false agentImmediate: false responses: '200': description: Successfully updated the redaction entity. content: application/json: schema: type: object properties: id: type: string description: The id of the redaction entity example: CREDIT_CARD_NUMBER description: type: string description: The description of the redaction entity example: '' policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - id - description - policies example: id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/structured-data-fields: get: tags: - Configuration summary: List structured data fields parameters: - in: query name: active schema: type: boolean nullable: true description: Filter by active or non active redaction entities - in: query name: cursor schema: type: string nullable: true description: The cursor pointing to the current position - in: query name: limit schema: type: integer nullable: true minimum: 1 maximum: 100 default: 20 description: The maximum amount of objects to retrieve description: | Retrieves a list of all configured structured data fields. operationId: getStructuredDataFields responses: '200': description: Get all structured data fields. content: application/json: schema: type: object properties: structuredDataFields: type: array description: Structured data fields list items: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: > The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: >- Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: > The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: >- Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: >- Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - structuredDataFields - nextCursor - prevCursor example: structuredDataFields: - id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true nextCursor: e_product prevCursor: q_call_transferred '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message post: tags: - Configuration summary: Create a structured data field description: > Creates a new structured data field configuration that defines what information should be extracted from conversations. This endpoint supports creating two types of structured data fields: 1. QUESTION type: Defines specific questions to be answered about the conversation Example: "Did the agent offer the correct promotion?" 2. ENTITY type: Defines entities to be identified and extracted Example: Product names mentioned in the conversation These fields are used by the Structured Data API (/apis/autosummary/retrieve-structured-data) to automatically extract the configured information from conversations. operationId: postStructuredDataField requestBody: required: true content: application/json: schema: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: >- Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true responses: '201': description: Structured data field created. content: application/json: schema: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: >- Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/structured-data-fields/{structuredDataFieldId}: parameters: - name: structuredDataFieldId description: Identifier of the structured data field in: path required: true schema: type: string get: tags: - Configuration summary: Retrieve a structured data field operationId: getStructuredDataField description: | Get a specific structured data field specifying the id responses: '200': description: Successfully retrieved the structured data field. content: application/json: schema: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: >- Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message put: tags: - Configuration summary: Update a structured data field operationId: putStructuredDataField description: | Update a specific structured data field specifying the id requestBody: required: true content: application/json: schema: description: Update a structured data field type: object oneOf: - type: object properties: name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: The type of the object example: QUESTION active: type: boolean description: Indicates if the structured data is active or not example: false question: type: object properties: question: type: string description: The question of of the structured data field example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - active - question - type - categoryId - name - segmentIds example: name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - type: object properties: name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: The type of the object example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity example: Product Name description: type: string description: The description of the entity example: >- Product of the company being discussed in the conversation examples: type: array items: type: string example: Special trekking socks description: Entities examples required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - active - entity - type - categoryId - name - segmentIds example: name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: >- Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true example: name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true responses: '200': description: Successfully updated the structured data field. content: application/json: schema: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: >- Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message delete: tags: - Configuration summary: Delete a structured data field operationId: deleteStructuredDataField description: | Delete a specific structured data field specifying the id responses: '200': description: Successfully deleted the structured data field. '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/segments: get: tags: - Configuration summary: List segments parameters: - in: query name: cursor schema: type: string nullable: true description: The cursor pointing to the current position - in: query name: limit schema: type: integer nullable: true minimum: 1 maximum: 100 default: 20 description: The maximum amount of objects to retrieve description: | Retrieves a list of all segments. operationId: getSegments responses: '200': description: Get all segments. content: application/json: schema: description: Response for get segments. type: object properties: segments: type: array description: Segments list items: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - segments - nextCursor - prevCursor example: segments: - id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' nextCursor: CHAT prevCursor: '' '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message post: tags: - Configuration summary: Create a segment description: > Creates a new `segment` to organize structured data extraction based on conversation metadata. A segment consists of: 1. Query logic that matches conversations based on metadata 2. A set of structured data fields to extract from matching conversations For example, you can create segments to: - Extract problem details from support conversations - Extract product and promotion info from sales conversations operationId: postSegment requestBody: required: true content: application/json: schema: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] responses: '201': description: Segment created. content: application/json: schema: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message /configuration/v1/segments/{segmentId}: parameters: - name: segmentId description: Identifier of the segment in: path required: true schema: type: string get: tags: - Configuration summary: Retrieve a segment operationId: getSegment description: | Get a specific segment specifying the id responses: '200': description: Successfully retrieved the seg,emt. content: application/json: schema: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message patch: tags: - Configuration summary: Partial update a segment operationId: patchSegment description: Update a specific segment specifying the id requestBody: required: true content: application/json: schema: description: Update a segment type: object properties: name: type: string description: The name of the segment example: Chat segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: Structured data fields ids example: structuredDataFieldIds: [] responses: '200': description: Successfully updated the segment. content: application/json: schema: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message delete: tags: - Configuration summary: Delete a segment operationId: deleteSegment description: Delete a specific segment specifying the id responses: '200': description: Successfully deleted the segment. '400': description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '401': description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '403': description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '404': description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '409': description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '413': description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '422': description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '429': description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '500': description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message '503': description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message components: responses: BadRequest: description: 400 - Bad request content: application/json: schema: description: Bad request response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 400-01 message: Bad request description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message DefaultError: description: 500 - Internal Server Error content: application/json: schema: description: Default error response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 500-01 message: Internal server error description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message Unauthorized: description: 401 - Unauthorized content: application/json: schema: description: Unauthorized response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 401-01 message: Unauthorized description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message Forbidden: description: 403 - Forbidden content: application/json: schema: description: Forbidden response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 403-01 message: Forbidden Response description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message NotFound: description: 404 - Not Found content: application/json: schema: description: Not Found response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 404-01 message: Not Found description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message Conflict: description: 409 - Conflict content: application/json: schema: description: Conflict response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 409-01 message: Conflict description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message RequestEntityTooLarge: description: 413 - Request Entity Too Large content: application/json: schema: description: Request Entity Too Large response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 413-01 message: Request Entity Too Large description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message UnprocessableEntity: description: 422 - Unprocessable Entity content: application/json: schema: description: Unprocessable Entity response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 422-01 message: Unprocessable Entity description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message TooManyRequests: description: 429 - Too Many Requests content: application/json: schema: description: Too Many Requests response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 429-01 message: Too Many Requests description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message ServiceUnavailable: description: 503 - Service Unavailable content: application/json: schema: description: Service Unavailable response type: object properties: error: example: requestId: 8e033668-9f1a-11ec-b909-0242ac120002 code: 503-01 message: Service Unavailable description: Error details type: object properties: requestId: type: string description: Unique ID of the failing request message: type: string description: Error message code: type: string description: Error code required: - requestId - message securitySchemes: API-ID: type: apiKey in: header name: asapp-api-id API-Secret: type: apiKey in: header name: asapp-api-secret parameters: customVocabularyId: name: customVocabularyId description: Identifier of the custom vocabulary in: path required: true schema: type: string active: in: query name: active schema: type: boolean nullable: true description: Filter by active or non active redaction entities cursor: in: query name: cursor schema: type: string nullable: true description: The cursor pointing to the current position limit: in: query name: limit schema: type: integer nullable: true minimum: 1 maximum: 100 default: 20 description: The maximum amount of objects to retrieve entityId: name: entityId description: Identifier of the entity in: path required: true schema: type: string structuredDataFieldId: name: structuredDataFieldId description: Identifier of the structured data field in: path required: true schema: type: string segmentId: name: segmentId description: Identifier of the segment in: path required: true schema: type: string schemas: NextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da PrevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c CustomVocabularyConfig: type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E CustomVocabulary: type: object allOf: - type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E - type: object properties: id: type: string description: The id of the custom vocabulary CustomVocabularies: type: array items: description: A list of custom vocabularies. example: id: '1' phrase: IEEE soundsLike: - I triple E type: object allOf: - type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E - type: object properties: id: type: string description: The id of the custom vocabulary CustomVocabulariesResponse: type: object properties: customVocabularies: type: array items: description: A list of custom vocabularies. example: id: '1' phrase: IEEE soundsLike: - I triple E type: object allOf: - type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string required: - phrase - soundsLike example: phrase: IEEE soundsLike: - I triple E - type: object properties: id: type: string description: The id of the custom vocabulary nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - customVocabularies - nextCursor - prevCursor CreateCustomVocabulariesRequest: type: object properties: phrase: type: string description: >- The phrase to be added to the custom vocabulary. This is the phrase you want to end up with in the transcription. example: I triple E soundsLike: type: array description: An array of phonetic representations of the phrase. items: type: string example: IEEE required: - phrase - soundsLike example: phrase: I triple E soundsLike: - IEEE RedactionPolicies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false RedactionEntityItem: type: object properties: id: type: string description: The id of the redaction entity example: CREDIT_CARD_NUMBER description: type: string description: The description of the redaction entity example: '' policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - id - description - policies example: id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false GetRedactionEntitiesResponse: type: object properties: redactionEntities: type: array description: The list of redaction entities items: type: object properties: id: type: string description: The id of the redaction entity example: CREDIT_CARD_NUMBER description: type: string description: The description of the redaction entity example: '' policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - id - description - policies example: id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - redactionEntities - nextCursor - prevCursor example: redactionEntities: - id: CREDIT_CARD_NUMBER description: Redacts credit card number policies: customerImmediate: false customerDelayed: false agentImmediate: false nextCursor: CVV prevCursor: PHONE_NUMBER UpdateRedactionEntity: type: object properties: policies: description: >- A set of policies that control when and how redaction is applied. Each policy can be enabled or disabled independently. Some entities may have a subset of policies. Specifying a policy that is not applicable to an entity will be ignored. type: object properties: customerImmediate: type: boolean description: >- Immediately redact sensitive information from the customer's view during the live conversation. This is typically used for highly sensitive data like credit card numbers that should never be visible to customers. example: true customerDelayed: type: boolean description: >- Temporarily show sensitive information to the customer before applying redaction. This allows customers to verify the information was captured correctly before it gets redacted. example: false agentImmediate: type: boolean description: >- Immediately redact sensitive information from the agent's view. This prevents agents from seeing confidential customer data while still allowing them to assist with the interaction. example: false autoTranscribe: type: boolean description: >- Redact sensitive information from conversation transcripts. This ensures sensitive data is not stored in transcription records while preserving the context of the conversation. example: false voice: type: boolean description: Redact sensitive information during voice calls. example: false required: - policies example: policies: customerImmediate: false customerDelayed: false agentImmediate: false StructuredDataFieldQuestion: title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true StructuredDataFieldEntity: title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true StructuredDataFieldQuestionNoId: type: object properties: name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: The type of the object example: QUESTION active: type: boolean description: Indicates if the structured data is active or not example: false question: type: object properties: question: type: string description: The question of of the structured data field example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: The segment ids that the structured data field is associated with example: GLOBAL required: - active - question - type - categoryId - name - segmentIds example: name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true StructuredDataFieldEntityNoId: type: object properties: name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: The type of the object example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity example: Product Name description: type: string description: The description of the entity example: Product of the company being discussed in the conversation examples: type: array items: type: string example: Special trekking socks description: Entities examples required: - name - description - examples segmentIds: type: array items: type: string description: The segment ids that the structured data field is associated with example: GLOBAL required: - active - entity - type - categoryId - name - segmentIds example: name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true StructuredDataFields: type: array description: A list of structured data fields. items: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true GetStructuredDataFieldsResponse: type: object properties: structuredDataFields: type: array description: Structured data fields list items: oneOf: - title: Question type: object properties: id: type: string description: The id of the structured data field example: q_promotion_was_offered name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: | The category of the structured data field. Possible values: - OUTCOME example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: QUESTION active: type: boolean description: Indicates if the structured data is active or not. example: false question: type: object properties: question: type: string description: >- The question that will be answered using the context of the conversation example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - question - type - categoryId - name - segmentIds example: id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - title: Entity type: object properties: id: type: string description: The id of the structured data field example: e_product name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: | The type of the structured data field. Must be either: - QUESTION - ENTITY example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity. example: Product Name description: type: string description: The description of the entity. example: >- Product of the company being discussed in the conversation. examples: type: array items: type: string example: Special trekking socks description: >- A list of example entities that can be extracted from the conversation. required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - id - active - entity - type - categoryId - name - segmentIds example: id: e_product name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - structuredDataFields - nextCursor - prevCursor example: structuredDataFields: - id: q_promotion_was_offered name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true nextCursor: e_product prevCursor: q_call_transferred UpdateStructuredDataField: description: Update a structured data field type: object oneOf: - type: object properties: name: type: string description: The name of the structured data field example: Promotion was offered categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: The type of the object example: QUESTION active: type: boolean description: Indicates if the structured data is active or not example: false question: type: object properties: question: type: string description: The question of of the structured data field example: Did the agent offer the correct promotion? required: - question segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - active - question - type - categoryId - name - segmentIds example: name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true - type: object properties: name: type: string description: The name of the structured data field example: Product Name categoryId: type: string description: The category id assigned example: OUTCOME type: type: string description: The type of the object example: ENTITY active: type: boolean description: Indicates if the structured data is active or not example: false entity: type: object properties: name: type: string description: The name of the entity example: Product Name description: type: string description: The description of the entity example: Product of the company being discussed in the conversation examples: type: array items: type: string example: Special trekking socks description: Entities examples required: - name - description - examples segmentIds: type: array items: type: string description: >- The segment ids that the structured data field is associated with example: GLOBAL required: - active - entity - type - categoryId - name - segmentIds example: name: Product Name categoryId: OUTCOME type: ENTITY entity: name: Product Name description: Product of the company being discussed in the conversation examples: - Pink blazer - Special trekking socks - Super Backpack active: true example: name: Promotion was offered categoryId: OUTCOME type: QUESTION question: question: Did the agent offer the correct promotion? active: true SegmentRawQuery: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. Segment: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] GetSegmentsResponse: description: Response for get segments. type: object properties: segments: type: array description: Segments list items: description: Segment type: object properties: id: type: string description: The id of the segment name: type: string description: The name of the segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: >- The ids of the structured data fields that will be used to generate the structured data for the conversation. example: id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' structuredDataFieldIds: [] nextCursor: type: string nullable: true description: The next cursor to fetch example: 6b29fc40-ca47-1067-b31d-00dd010662da prevCursor: type: string nullable: true description: The previous cursor to fetch example: 04719ebd-13e1-40e9-8b92-0941cd16a19c required: - segments - nextCursor - prevCursor example: segments: - id: USER_SUPPORT name: Support query: type: raw raw: 'TRUE' nextCursor: CHAT prevCursor: '' PartialUpdateSegment: description: Update a segment type: object properties: name: type: string description: The name of the segment example: Chat segment query: description: >- A query that defines which conversations belong to this segment based on their metadata. type: object properties: type: type: string description: Query type (only `raw` supported) raw: type: string description: > An [SQL-like query string expression](/autosummary/structured-data/segments-and-customization#query) to match conversations based on their metadata. structuredDataFieldIds: type: array items: type: string description: Structured data fields ids example: structuredDataFieldIds: []