Von der Data QnA API zur Conversational Analytics API migrieren

In dieser Anleitung werden die wichtigsten Unterschiede und die Schritte für die Migration Ihrer Anwendungen von der Data QnA API (dataqna.googleapis.com) zur Conversational Analytics API (geminidataanalytics.googleapis.com) beschrieben.

Feedback geben

Sollten während der Migration Abweichungen auftreten, wenden Sie sich bitte an conversational-analytics-api-feedback@google.com.

Wichtige Änderungen im Überblick

Bei der Conversational Analytics API wurden der API-Endpunkt, der von der API verwendete Dienst und die Struktur von API-Anfragen geändert. In der folgenden Tabelle finden Sie eine Zusammenfassung der wichtigsten Unterschiede zwischen der Data QnA API und der Conversational Analytics API sowie eine Liste der erforderlichen Migrationsschritte.

Data QnA API Conversational Analytics API Erforderliche Änderung
Endpunkt dataqna.googleapis.com Endpunkt geminidataanalytics.googleapis.com Aktualisieren Sie den API-Endpunkt in Ihren Anfragen.
Dienst DataQuestionService Dienst DataChatService Aktualisieren Sie den Dienstnamen in Ihren Anfragen.
Feld project in der Nachricht AskQuestionRequest Feld parent in der Nachricht ChatRequest Ersetzen Sie das Feld project in Ihren Anfragen durch das Feld parent. Weitere Informationen finden Sie unter project durch parent für das Anfragenrouting ersetzen.
Feld datasource_ids Feld studio_references Ersetzen Sie das Feld datasource_ids in Ihren Anfragen durch das Feld studio_references. Weitere Informationen finden Sie unter Verweise auf Looker Studio-Datenquellen-IDs aktualisieren.
Objekt AgentConfig Objekt ConversationOptions Ersetzen Sie das Objekt AgentConfig in Ihren Anfragen durch das Objekt ConversationOptions. Weitere Informationen finden Sie unter Python-Analyse mit ConversationOptions aktivieren.
Feld context in der Nachricht AskQuestionRequest Feld inline_context in der Nachricht ChatRequest Ersetzen Sie das Feld context in Ihren Anfragen durch das Feld inline_context. Weitere Informationen finden Sie unter context durch inline_context ersetzen.

Beispiele für die Aktualisierung Ihrer API-Anfragestrukturen finden Sie unter Beispiele: API-Anfragestrukturen aktualisieren.

project durch parent für das Anfragerouting ersetzen

In der Data QnA API verwenden Sie das Feld project in der Nachricht AskQuestionRequest, um das Google Cloud -Projekt anzugeben. In der Conversational Analytics API wird das Feld project in der Nachricht ChatRequest nicht mehr unterstützt. Stattdessen verwenden Sie das Feld parent, um sowohl das Projekt als auch den Ort anzugeben.

Das folgende Beispiel zeigt das Format, in dem das Feld parent angegeben wird:

parent: "projects/your_project_name/locations/global"

Ersetzen Sie im vorherigen Beispiel your_project_name durch den Namen Ihres Google Cloud -Projekts.

Verweise auf Looker Studio-Datenquellen-IDs aktualisieren

In der Data QnA API verwenden Sie das Feld datasource_ids, um eine Liste mit Looker Studio-Datenquellen-IDs anzugeben. In der Conversational Analytics API verwenden Sie das Feld studio_references, um eine Liste von Objekten des Typs StudioDatasourceReference anzugeben, die jeweils eine einzelne Datenquellen-ID enthalten. Weitere Informationen finden Sie unter StudioDatasourceReferences.

Python-Analyse mit ConversationOptions aktivieren

Das Objekt AgentConfig, das in der Data QnA API zum Aktivieren von Tools verwendet wird, wird vom Dienst DataChatService in der Conversational Analytics API nicht verwendet. Wenn Sie Funktionen wie die Python-Analyse in der Conversational Analytics API aktivieren möchten, verwenden Sie das Objekt ConversationOptions, wenn Sie einen KI-Datenagenten erstellen oder konfigurieren. Weitere Informationen finden Sie unter ConversationOptions.

context durch inline_context ersetzen

In der Data QnA API enthält die Nachricht AskQuestionRequest das Feld context für kontextbezogene Inline-Informationen. In der Conversational Analytics API wird das Feld context in der Nachricht ChatRequest in inline_context umbenannt. Durch diese Änderung lässt sich Inline-Kontext besser von anderen Kontexttypen unterscheiden, die über KI-Datenagenten bereitgestellt werden können.

Beispiele: API-Anfragestrukturen aktualisieren

Die folgenden Beispiele zeigen, wie Sie Ihre Anfragen an die neue API-Struktur anpassen, wenn Sie von der Data QnA API zur Conversational Analytics API migrieren. Diese Beispiele umfassen BigQuery-, Looker- und Looker Studio-Datenquellen.

BigQuery-Datenquelle

In diesem Abschnitt finden Sie ein Beispiel dafür, wie Sie Ihre API-Anfragen für BigQuery-Datenquellen aktualisieren. Im Beispiel wird gezeigt, wie eine Anfrage aktualisiert wird, in der ein Balkendiagramm der fünf Bundesstaaten mit den meisten Flughäfen angefordert wird.

Das folgende Codebeispiel zeigt die Anfragestruktur für die 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"
      }
    }
  }
}

Das folgende Codebeispiel zeigt die aktualisierte Anfragestruktur für die 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"
      }
    }
  }

In den vorherigen Beispielen können Sie die Beispielwerte so ersetzen:

  • your_project_name: Der Name Ihres Google Cloud -Projekts.
  • your_project_id: Die ID Ihres BigQuery-Projekts. Wenn Sie eine Verbindung zu einem öffentlichen Dataset herstellen möchten, geben Sie bigquery-public-data an.
  • your_dataset_id: Die ID des BigQuery-Datasets. Beispiel: faa.
  • your_table_id: Die ID der BigQuery-Tabelle. Beispiel: us_airports.

Looker-Datenquelle

In diesem Abschnitt finden Sie ein Beispiel dafür, wie Sie Ihre API-Anfragen für Looker-Datenquellen aktualisieren. Das Beispiel zeigt, wie eine Anfrage aktualisiert wird, in der die Anzahl der Bestellungen nach Bestellstatus angefordert wird.

Das folgende Codebeispiel zeigt die Anfragestruktur für die 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"
          }
        }
      }
    }
  }
}

Das folgende Codebeispiel zeigt die aktualisierte Anfragestruktur für die 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"
          }
        }
      }
    }
  }
}

In den vorherigen Beispielen können Sie die Beispielwerte so ersetzen:

  • your_project_name: Der Name Ihres Google Cloud -Projekts
  • https://your_company.looker.com: Der URI Ihrer Looker-Instanz
  • your_model: Der Name Ihres LookML-Modells
  • your_explore: Der Name Ihrer LookML-Analyse
  • your_looker_client_id: Ihre Looker-Client-ID
  • your_looker_client_secret: Ihr Looker-Clientschlüssel

Looker Studio-Datenquelle

In diesem Abschnitt finden Sie ein Beispiel dafür, wie Sie Ihre API-Anfragen für Looker Studio-Datenquellen aktualisieren. Im Beispiel wird gezeigt, wie eine Anfrage aktualisiert wird, in der ein Balkendiagramm mit den fünf wichtigsten Mobilfunkanbietern angefordert wird.

Das folgende Codebeispiel zeigt die Anfragestruktur für die 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"
    }
  }
}

Das folgende Codebeispiel zeigt die aktualisierte Anfragestruktur für die 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"
    }
  }
}

In den vorherigen Beispielen können Sie die Beispielwerte so ersetzen:

  • your_project_name: Der Name Ihres Google Cloud -Projekts
  • your_data_source_id: Die ID Ihrer Looker Studio-Datenquelle