Method: properties.chat

توفّر واجهة محادثة للتفاعل مع بيانات "إحصاءات Google" من خلال واجهة برمجة التطبيقات.

يستخدم هذا المنتج الذكاء الاصطناعي وقد يعرض أحيانًا معلومات غير دقيقة. قد نستند إلى نشاط المحادثة الخاص بكم لتحسين المنتج، ويخضع استخدامكم له لبنود الخدمة وسياسة استخدام الذكاء الاصطناعي وسياسة الخصوصية في Google. مزيد من المعلومات عن الخصوصية في محادثات الذكاء الاصطناعي في المواقع

طلب HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:chat

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
property

string

الحقل مطلوب. السمة التي تريد التحدّث عنها التنسيق: properties/{property}

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "userQuery": string,
  "returnPropertyQuota": boolean,
  "sessionId": string
}
الحقول
userQuery

string

الحقل مطلوب. طلب بحث المستخدم
returnPropertyQuota

boolean

اختياريّ. إذا كانت القيمة true، ستتضمّن الاستجابة الحالة الحالية لحصة هذا الموقع على "إحصاءات Google". يتم عرض الحصة في PropertyChatQuota.
sessionId

string

اختياريّ. قدِّم معرّف الجلسة هذا لمواصلة محادثة حالية والحفاظ على السياق. إذا كان هذا الحقل فارغًا أو لم يتم ضبطه، سيتم إنشاء جلسة محادثة جديدة. سيؤدي استخدام معرّفات جلسات غير صالحة إلى حدوث خطأ.

نص الاستجابة

رسالة الردّ لطريقة properties.chat.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "sessionId": string,
  "blocks": [
    {
      object (ResponseBlock)
    }
  ],
  "propertyQuota": {
    object (PropertyChatQuota)
  }
}
الحقول
sessionId

string

المعرّف الفريد لجلسة المحادثة هذه. قدِّم هذا المعرّف في الطلبات اللاحقة للحفاظ على سياق المحادثة.
blocks[]

object (ResponseBlock)

حظر الردود التي تشكّل رد المحادثة يمكن أن يشمل ذلك النصوص والجداول والقوائم.
propertyQuota

object (PropertyChatQuota)

حالة حصة موقع "إحصاءات Google" هذا، بما في ذلك هذا الطلب.

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/analytics.chatbot.read

ResponseBlock

كتلة واحدة من البيانات المنظَّمة في ردّ المحادثة

تمثيل JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "table": {
    object (DataTable)
  }
  // End of mutually exclusive fields.
}
الحقول
كتلة واحدة من البيانات المنظَّمة في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
text

string

مجموعة من النصوص
table

object (DataTable)

يشير هذا المصطلح إلى مجموعة من بيانات الجدول.
نهاية الحقول التي يستبعد كلّ منها الآخر

DataTable

جدول بيانات

تمثيل JSON 
{
  "headers": [
    {
      object (DataTableHeader)
    }
  ],
  "rows": [
    {
      object (DataTableRow)
    }
  ]
}
الحقول
headers[]

object (DataTableHeader)

تصف أعمدة السمات. يتطابق عدد العناوين وترتيبها مع السمات المتوفّرة في الصفوف.
rows[]

object (DataTableRow)

صفوف تتضمّن مجموعات من قيم السمات وقيم المقاييس في التقرير

DataTableHeader

تصف هذه السمة عنوان عمود في DataTable.

تمثيل JSON 
{
  "header": string,
  "dataType": string
}
الحقول
header

string

اسم العنوان
dataType

string

نوع البيانات

DataTableRow

صف في DataTable

تمثيل JSON 
{
  "columns": [
    {
      object (DataTableCell)
    }
  ]
}
الحقول
columns[]

object (DataTableCell)

قيم الخلايا في الصف

DataTableCell

خلية في جدول بيانات

تمثيل JSON 
{
  "value": string
}
الحقول
value

string

تمثّل هذه السمة قيمة الخلية.

PropertyChatQuota

حصة المواقع للحقول الخاصة ببرامج الدردشة الآلية

تمثيل JSON 
{
  "tokensPerDay": {
    object (QuotaStatus)
  },
  "tokensPerHour": {
    object (QuotaStatus)
  }
}
الحقول
tokensPerDay

object (QuotaStatus)

الرموز المميّزة المستخدَمة ضمن حصة Chat للموقع في اليوم
tokensPerHour

object (QuotaStatus)

الرموز المميّزة المستخدَمة ضمن حصة الموقع في الساعة