Contact Center AI Insights API (contactcenterinsights:v1)

2025-05-01

5 new methods

Additions

    Methods
  • contactcenterinsights.projects.locations.datasets.insightsdata.export

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Export insights data to a destination defined in the request body.

      Parameter Order : parent

      Path : v1/{+parent}/insightsdata:export

      Parameters :

        parent

          Description : Required. The parent resource to export data from.

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$

          Type : string

          Required : Yes

          Location : path

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/insightsdata:export

  • contactcenterinsights.projects.locations.datasets.conversations.ingest

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : parent

      Path : v1/{+parent}/conversations:ingest

      Description : Imports conversations and processes them according to the user's configuration.

      Parameters :

        parent

          Description : Required. The parent resource for new conversations.

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$

          Type : string

      HTTP Method : POST

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:ingest

  • contactcenterinsights.projects.locations.datasets.conversations.get

      Parameter Order : name

      Path : v1/{+name}

      HTTP Method : GET

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$

          Type : string

          Required : Yes

          Description : Required. The name of the conversation to get.

        view

          Description : The level of details of the conversation. Default is `FULL`.

          Enum :

        • CONVERSATION_VIEW_UNSPECIFIED
        • FULL
        • BASIC
        • Enum Descriptions :

        • The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.
        • Populates all fields in the conversation.
        • Populates all fields in the conversation except the transcript.
        • Type : string

          Location : query

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets a conversation.

  • contactcenterinsights.projects.locations.datasets.conversations.delete

      Parameter Order : name

      Path : v1/{+name}

      HTTP Method : DELETE

      Description : Deletes a conversation.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameters :

        force

          Type : boolean

          Location : query

          Description : If set to true, all of this conversation's analyses will also be deleted. Otherwise, the request will only succeed if the conversation has no analyses.

        name

          Description : Required. The name of the conversation to delete.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$

          Location : path

          Type : string

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}

  • contactcenterinsights.projects.locations.datasets.conversations.list

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists conversations.

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations

      Parameter Order : parent

      HTTP Method : GET

      Path : v1/{+parent}/conversations

      Parameters :

        pageToken

          Type : string

          Description : The value returned by the last `ListConversationsResponse`. This value indicates that this is a continuation of a prior `ListConversations` call and that the system should return the next page of data.

          Location : query

        orderBy

          Location : query

          Description : Optional. The attribute by which to order conversations in the response. If empty, conversations will be ordered by descending creation time. Supported values are one of the following: * create_time * customer_satisfaction_rating * duration * latest_analysis * start_time * turn_count The default sort order is ascending. To specify order, append `asc` or `desc` (`create_time desc`). For more details, see [Google AIPs Ordering](https://google.aip.dev/132#ordering).

          Type : string

        pageSize

          Description : The maximum number of conversations to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.

          Format : int32

          Type : integer

          Location : query

        filter

          Type : string

          Location : query

          Description : A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.

        view

          Location : query

          Description : The level of details of the conversation. Default is `BASIC`.

          Enum :

        • CONVERSATION_VIEW_UNSPECIFIED
        • FULL
        • BASIC
        • Enum Descriptions :

        • The conversation view is not specified. * Defaults to `FULL` in `GetConversationRequest`. * Defaults to `BASIC` in `ListConversationsRequest`.
        • Populates all fields in the conversation.
        • Populates all fields in the conversation except the transcript.
        • Type : string

        parent

          Description : Required. The parent resource of the conversation.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$

          Type : string

          Location : path