Bermigrasi dari Data QnA API ke Conversational Analytics API

Panduan ini menjelaskan perbedaan utama dan langkah-langkah untuk memigrasikan aplikasi Anda dari Data QnA API (dataqna.googleapis.com) ke Conversational Analytics API (geminidataanalytics.googleapis.com).

Berikan masukan

Jika Anda menemukan perbedaan selama proses migrasi, hubungi conversational-analytics-api-feedback@google.com.

Ringkasan perubahan penting

Conversational Analytics API memperkenalkan perubahan pada endpoint API, layanan yang digunakan API, dan struktur permintaan API. Tabel berikut merangkum perbedaan utama antara Data QnA API dan Conversational Analytics API serta mencantumkan langkah-langkah yang diperlukan untuk migrasi.

Data QnA API Conversational Analytics API Perubahan yang diperlukan
Endpoint dataqna.googleapis.com Endpoint geminidataanalytics.googleapis.com Perbarui endpoint API dalam permintaan Anda.
Layanan DataQuestionService Layanan DataChatService Perbarui nama layanan dalam permintaan Anda.
Kolom project dalam pesan AskQuestionRequest Kolom parent dalam pesan ChatRequest Ganti kolom project dengan kolom parent dalam permintaan Anda. Untuk mengetahui informasi selengkapnya, lihat Mengganti project dengan parent untuk perutean permintaan.
Kolom datasource_ids Kolom studio_references Ganti kolom datasource_ids dengan kolom studio_references dalam permintaan Anda. Untuk mengetahui informasi selengkapnya, lihat Memperbarui referensi ke ID sumber data Looker Studio.
Objek AgentConfig Objek ConversationOptions Ganti objek AgentConfig dengan objek ConversationOptions dalam permintaan Anda. Untuk mengetahui informasi selengkapnya, lihat Mengaktifkan analisis Python dengan ConversationOptions.
Kolom context dalam pesan AskQuestionRequest Kolom inline_context dalam pesan ChatRequest Ganti kolom context dengan kolom inline_context dalam permintaan Anda. Untuk mengetahui informasi selengkapnya, lihat Mengganti context dengan inline_context.

Untuk contoh cara memperbarui struktur permintaan API, lihat Contoh: Memperbarui struktur permintaan API.

Ganti project dengan parent untuk perutean permintaan

Di Data QnA API, Anda menggunakan kolom project dalam pesan AskQuestionRequest untuk menentukan project Google Cloud . Di Conversational Analytics API, kolom project tidak digunakan lagi dalam pesan ChatRequest. Sebagai gantinya, Anda menggunakan kolom parent untuk menentukan project dan lokasi.

Contoh berikut menunjukkan format untuk menentukan kolom parent:

parent: "projects/your_project_name/locations/global"

Pada contoh sebelumnya, ganti your_project_name dengan nama project Google Cloud Anda.

Memperbarui referensi ke ID sumber data Looker Studio

Di Data QnA API, Anda menggunakan kolom datasource_ids untuk memberikan daftar ID sumber data Looker Studio. Di Conversational Analytics API, Anda menggunakan kolom studio_references untuk memberikan daftar objek StudioDatasourceReference, yang masing-masing berisi satu ID sumber data. Untuk mengetahui informasi selengkapnya, lihat StudioDatasourceReferences.

Mengaktifkan analisis Python dengan ConversationOptions

Objek AgentConfig, yang digunakan di Data QnA API untuk mengaktifkan alat, tidak digunakan oleh layanan DataChatService di Conversational Analytics API. Untuk mengaktifkan fitur seperti analisis Python di Conversational Analytics API, gunakan objek ConversationOptions saat Anda membuat atau mengonfigurasi agen data. Untuk mengetahui informasi selengkapnya, lihat ConversationOptions.

Ganti context dengan inline_context.

Di Data QnA API, pesan AskQuestionRequest menyertakan kolom context untuk informasi kontekstual inline. Di Conversational Analytics API, kolom context diganti namanya menjadi inline_context dalam pesan ChatRequest. Perubahan ini membantu membedakan konteks inline dari jenis konteks lain yang dapat diberikan melalui agen data.

Contoh: Memperbarui struktur permintaan API

Contoh berikut menunjukkan cara menyesuaikan permintaan Anda dengan struktur API baru saat Anda bermigrasi dari Data QnA API ke Conversational Analytics API. Contoh ini mencakup sumber data BigQuery, Looker, dan Looker Studio.

Sumber data BigQuery

Bagian ini memberikan contoh cara memperbarui permintaan API untuk sumber data BigQuery. Contoh ini menunjukkan cara memperbarui permintaan yang meminta diagram batang yang menampilkan lima negara bagian teratas berdasarkan jumlah total bandara.

Contoh kode berikut menunjukkan struktur permintaan untuk Data QnA API:

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"
      }
    }
  }
}

Contoh kode berikut menunjukkan struktur permintaan yang diperbarui untuk Conversational Analytics API:

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"
      }
    }
  }

Untuk contoh sebelumnya, Anda dapat mengganti nilai sampel sebagai berikut:

  • your_project_name: Nama project Google Cloud Anda.
  • your_project_id: ID project BigQuery Anda. Untuk terhubung ke set data publik, tentukan bigquery-public-data.
  • your_dataset_id: ID set data BigQuery. Contoh, faa.
  • your_table_id: ID tabel BigQuery. Contoh, us_airports.

Sumber data Looker

Bagian ini memberikan contoh cara memperbarui permintaan API untuk sumber data Looker. Contoh ini menunjukkan cara memperbarui permintaan yang meminta jumlah pesanan menurut status pesanan.

Contoh kode berikut menunjukkan struktur permintaan untuk Data QnA API:

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"
          }
        }
      }
    }
  }
}

Contoh kode berikut menunjukkan struktur permintaan yang diperbarui untuk Conversational Analytics API:

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"
          }
        }
      }
    }
  }
}

Untuk contoh sebelumnya, Anda dapat mengganti nilai sampel sebagai berikut:

  • your_project_name: Nama Google Cloud project Anda
  • https://your_company.looker.com: URI instance Looker Anda
  • your_model: Nama model LookML Anda
  • your_explore: Nama Eksplorasi LookML Anda
  • your_looker_client_id: ID klien Looker Anda
  • your_looker_client_secret: Rahasia klien Looker Anda

Sumber data Looker Studio

Bagian ini memberikan contoh cara memperbarui permintaan API untuk sumber data Looker Studio. Contoh ini menunjukkan cara memperbarui permintaan yang meminta grafik batang yang menampilkan lima operator teratas.

Contoh kode berikut menunjukkan struktur permintaan untuk Data QnA API:

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"
    }
  }
}

Contoh kode berikut menunjukkan struktur permintaan yang diperbarui untuk Conversational Analytics API:

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"
    }
  }
}

Untuk contoh sebelumnya, Anda dapat mengganti nilai sampel sebagai berikut:

  • your_project_name: Nama Google Cloud project Anda
  • your_data_source_id: ID sumber data Looker Studio Anda