Di chuyển từ API Data QnA sang API Phân tích trò chuyện

Hướng dẫn này mô tả các điểm khác biệt chính và các bước để di chuyển ứng dụng của bạn từ API Data QnA (dataqna.googleapis.com) sang API Phân tích trò chuyện (geminidataanalytics.googleapis.com).

Gửi ý kiến phản hồi

Nếu bạn gặp bất kỳ sự khác biệt nào trong quá trình di chuyển, hãy liên hệ với conversational-analytics-api-feedback@google.com.

Tổng quan về những thay đổi chính

API Phân tích trò chuyện sẽ giới thiệu các thay đổi đối với điểm cuối API, dịch vụ mà API sử dụng và cấu trúc của các yêu cầu API. Bảng sau đây tóm tắt những điểm khác biệt chính giữa API Data QnA và API Phân tích trò chuyện, đồng thời liệt kê các bước bắt buộc để di chuyển.

Data QnA API Conversational Analytics API Thay đổi bắt buộc
Điểm cuối dataqna.googleapis.com Điểm cuối geminidataanalytics.googleapis.com Cập nhật điểm cuối API trong các yêu cầu của bạn.
Dịch vụ DataQuestionService Dịch vụ DataChatService Cập nhật tên dịch vụ trong các yêu cầu của bạn.
Trường project trong thông báo AskQuestionRequest Trường parent trong thông báo ChatRequest Thay thế trường project bằng trường parent trong các yêu cầu của bạn. Để biết thêm thông tin, hãy xem phần Thay thế project bằng parent để định tuyến yêu cầu.
Trường datasource_ids Trường studio_references Thay thế trường datasource_ids bằng trường studio_references trong các yêu cầu của bạn. Để biết thêm thông tin, hãy xem bài viết Cập nhật tệp tham chiếu đến mã nguồn dữ liệu Looker Studio.
Đối tượng AgentConfig Đối tượng ConversationOptions Thay thế đối tượng AgentConfig bằng đối tượng ConversationOptions trong các yêu cầu của bạn. Để biết thêm thông tin, hãy xem phần Bật tính năng phân tích Python bằng ConversationOptions.
Trường context trong thông báo AskQuestionRequest Trường inline_context trong thông báo ChatRequest Thay thế trường context bằng trường inline_context trong các yêu cầu của bạn. Để biết thêm thông tin, hãy xem phần Thay thế context bằng inline_context.

Để biết ví dụ về cách cập nhật cấu trúc yêu cầu API, hãy xem phần Ví dụ: Cập nhật cấu trúc yêu cầu API.

Thay thế project bằng parent để định tuyến yêu cầu

Trong API Data QnA, bạn sử dụng trường project trong thông báo AskQuestionRequest để chỉ định dự án Google Cloud . Trong API Phân tích trò chuyện, trường project không còn được dùng trong thông báo ChatRequest. Thay vào đó, bạn sử dụng trường parent để chỉ định cả dự án và vị trí.

Ví dụ sau đây cho thấy định dạng để chỉ định trường parent:

parent: "projects/your_project_name/locations/global"

Trong ví dụ trước, hãy thay thế your_project_name bằng tên dự án Google Cloud .

Cập nhật các tệp tham chiếu đến mã nguồn dữ liệu Looker Studio

Trong API Hỏi đáp về dữ liệu, bạn sử dụng trường datasource_ids để cung cấp danh sách mã nguồn dữ liệu Looker Studio. Trong API Phân tích trò chuyện, bạn sử dụng trường studio_references để cung cấp danh sách các đối tượng StudioDatasourceReference, mỗi đối tượng chứa một mã nguồn dữ liệu. Để biết thêm thông tin, hãy xem StudioDatasourceReferences.

Bật tính năng phân tích Python bằng ConversationOptions

Đối tượng AgentConfig được dùng trong API Data QnA để bật các công cụ, không được dịch vụ DataChatService sử dụng trong API Phân tích trò chuyện. Để bật các tính năng như phân tích Python trong API Phân tích trò chuyện, hãy sử dụng đối tượng ConversationOptions khi bạn tạo hoặc định cấu hình tác nhân dữ liệu. Để biết thêm thông tin, hãy xem ConversationOptions.

Thay thế context bằng inline_context

Trong API Data QnA, thông báo AskQuestionRequest bao gồm trường context để cung cấp thông tin theo ngữ cảnh nội tuyến. Trong API Phân tích trò chuyện, trường context được đổi tên thành inline_context trong thông báo ChatRequest. Thay đổi này giúp phân biệt ngữ cảnh nội tuyến với các loại ngữ cảnh khác có thể được cung cấp thông qua tác nhân dữ liệu.

Ví dụ: Cập nhật cấu trúc yêu cầu API

Các ví dụ sau đây cho thấy cách điều chỉnh các yêu cầu của bạn cho phù hợp với cấu trúc API mới khi bạn di chuyển từ API Data QnA sang API Phân tích trò chuyện. Các ví dụ này bao gồm nguồn dữ liệu BigQuery, Looker và Looker Studio.

Nguồn dữ liệu BigQuery

Phần này cung cấp ví dụ về cách cập nhật các yêu cầu API cho nguồn dữ liệu BigQuery. Ví dụ này cho thấy cách cập nhật một yêu cầu yêu cầu biểu đồ thanh cho biết 5 tiểu bang hàng đầu theo tổng số sân bay.

Mã mẫu sau đây cho thấy cấu trúc yêu cầu của API Hỏi đáp về dữ liệu:

project: "projects/your_project_name"
messages {
  user_message {
    text: "Create a bar graph showing the top 5 states by the total number of airports."
  }
}
context {
  datasource_references {
    bq {
      table_references {
        project_id: "your_project_id"
        dataset_id: "your_dataset_id"
        table_id: "your_table_id"
      }
    }
  }
}

Mẫu mã sau đây cho thấy cấu trúc yêu cầu đã cập nhật cho API Phân tích trò chuyện:

messages {
  user_message {
    text: "Create a bar graph showing the top 5 states by the total number of airports."
  }
}
parent: "projects/your_project_name/locations/global"
inline_context {
  datasource_references {
    bq {
      table_references {
        project_id: "your_project_id"
        dataset_id: "your_dataset_id"
        table_id: "your_table_id"
      }
    }
  }

Đối với các ví dụ trước, bạn có thể thay thế các giá trị mẫu như sau:

  • your_project_name: Tên dự án Google Cloud .
  • your_project_id: Mã nhận dạng của dự án BigQuery. Để kết nối với một tập dữ liệu công khai, hãy chỉ định bigquery-public-data.
  • your_dataset_id: Mã nhận dạng của tập dữ liệu BigQuery. Ví dụ: faa.
  • your_table_id: Mã nhận dạng của bảng BigQuery. Ví dụ: us_airports.

Nguồn dữ liệu Looker

Phần này cung cấp ví dụ về cách cập nhật các yêu cầu API cho nguồn dữ liệu Looker. Ví dụ này cho thấy cách cập nhật một yêu cầu yêu cầu số lượng đơn đặt hàng theo trạng thái đơn đặt hàng.

Mã mẫu sau đây cho thấy cấu trúc yêu cầu của API Hỏi đáp về dữ liệu:

project: "projects/your_project_name"
messages {
  user_message {
    text: "Show the count of orders by order status."
  }
}
context {
  datasource_references {
    looker {
      explore_references {
        looker_instance_uri: "https://your_company.looker.com"
        lookml_model: "your_model"
        explore: "your_explore"
      }
      credentials {
        oauth {
          secret {
            client_id: "your_looker_client_id"
            client_secret: "your_looker_client_secret"
          }
        }
      }
    }
  }
}

Mẫu mã sau đây cho thấy cấu trúc yêu cầu đã cập nhật cho API Phân tích trò chuyện:

messages {
  user_message {
    text: "Show the count of orders by order status."
  }
}
parent: "projects/your_project_name/locations/global"
inline_context {
  datasource_references {
    looker {
      explore_references {
        lookml_model: "your_model"
        explore: "your_explore"
        looker_instance_uri: "https://your_company.looker.com"
      }
      credentials {
        oauth {
          secret {
            client_id: "your_looker_client_id"
            client_secret: "your_looker_client_secret"
          }
        }
      }
    }
  }
}

Đối với các ví dụ trước, bạn có thể thay thế các giá trị mẫu như sau:

  • your_project_name: Tên dự án Google Cloud
  • https://your_company.looker.com: URI của thực thể Looker
  • your_model: Tên mô hình LookML
  • your_explore: Tên của dữ liệu khám phá LookML
  • your_looker_client_id: Mã ứng dụng khách Looker của bạn
  • your_looker_client_secret: Khoá bí mật của ứng dụng khách Looker

Nguồn dữ liệu Looker Studio

Phần này cung cấp ví dụ về cách cập nhật các yêu cầu API cho nguồn dữ liệu Looker Studio. Ví dụ này cho thấy cách cập nhật một yêu cầu yêu cầu biểu đồ thanh cho biết 5 hãng hàng không hàng đầu.

Mã mẫu sau đây cho thấy cấu trúc yêu cầu của API Hỏi đáp về dữ liệu:

project: "projects/your_project_name"
messages {
  user_message {
    text: "Create a bar graph showing the top 5 carriers."
  }
}
context {
  datasource_references {
    studio {
      datasource_ids: "your_data_source_id"
    }
  }
}

Mẫu mã sau đây cho thấy cấu trúc yêu cầu đã cập nhật cho API Phân tích trò chuyện:

messages {
  user_message {
    text: "Create a bar graph showing the top 5 carriers."
  }
}
parent: "projects/your_project_name/locations/global"
inline_context {
  datasource_references {
    studio {
      datasource_ids: "your_data_source_id"
    }
  }
}

Đối với các ví dụ trước, bạn có thể thay thế các giá trị mẫu như sau:

  • your_project_name: Tên dự án Google Cloud
  • your_data_source_id: Mã nguồn dữ liệu Looker Studio