Method: projects.locations.apps.sessions.streamRunSession

הפעולה מתחילה אינטראקציה של תור אחד עם נציג CES. משתמש בהזרמה בצד השרת כדי לספק תוצאות מצטברות ותשובות חלקיות בזמן שהן נוצרות.

כברירת מחדל, תשובות מלאות (למשל, הודעות משיחות חוזרות או תשובות מלאות של LLM) נשלחות ללקוח ברגע שהן זמינות. כדי להפעיל סטרימינג של חלקי טקסט נפרדים ישירות מהמודל, מגדירים את enableTextStreaming לערך true.

בקשת HTTP

POST https://ces.googleapis.com/v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:streamRunSession

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
config.session

string

חובה. המזהה הייחודי של הסשן. פורמט: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "config": {
    "session": string,
    "inputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer,
      "noiseSuppressionLevel": string
    },
    "outputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer
    },
    "historicalContexts": [
      {
        "role": string,
        "chunks": [
          {
            object (Chunk)
          }
        ],
        "eventTime": string
      }
    ],
    "entryAgent": string,
    "deployment": string,
    "timeZone": string,
    "useToolFakes": boolean,
    "remoteDialogflowQueryParameters": {
      "webhookHeaders": {
        string: string,
        ...
      },
      "payload": {
        object
      },
      "endUserMetadata": {
        object
      }
    },
    "enableTextStreaming": boolean,
    "excludeDiagnosticInfo": boolean
  },
  "inputs": [
    {
      object (SessionInput)
    }
  ]
}
שדות
config.inputAudioConfig

object (InputAudioConfig)

זה שינוי אופציונלי. הגדרות לעיבוד האודיו שמתקבל מהקלט.
config.outputAudioConfig

object (OutputAudioConfig)

זה שינוי אופציונלי. הגדרות ליצירת פלט האודיו.
config.historicalContexts[]

object (Message)

זה שינוי אופציונלי. ההקשר ההיסטורי של הסשן, כולל קלט של משתמשים, תגובות של נציגים והודעות אחרות. בדרך כלל, סוכן CES מנהל את הסשן באופן אוטומטי, כך שהלקוח לא צריך למלא את השדה הזה באופן מפורש. עם זאת, הלקוח יכול לבטל את ההקשרים ההיסטוריים כדי לכפות על הסשן להתחיל ממצב מסוים.
config.entryAgent

string

זה שינוי אופציונלי. הנציג שאליו הועבר הטיפול בסשן. אם לא מציינים את הפרמטר הזה, הסשן יטופל על ידי root agent של האפליקציה. הפורמט: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
config.deployment

string

זה שינוי אופציונלי. הפריסה של האפליקציה שבה נעשה שימוש בסשן. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
config.timeZone

string

זה שינוי אופציונלי. אזור הזמן של המשתמש. אם מציינים אזור זמן, הסוכן ישתמש בו למשתנים שקשורים לתאריך ולשעה. אחרת, הסוכן ישתמש באזור הזמן שצוין ב-App.time_zone_settings.

הפורמט הוא אזור הזמן במסד הנתונים של אזורי הזמן של IANA, למשל America/Los_Angeles.
config.useToolFakes

boolean

זה שינוי אופציונלי. מציינת אם להשתמש ב-tool fakes בסשן. אם השדה הזה מוגדר, הסוכן ינסה להשתמש בזיופים של כלים במקום להפעיל את הכלים האמיתיים.
config.remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

זה שינוי אופציונלי. ‫QueryParameters לשליחה לסוכן Dialogflow המרוחק כשהשליטה בסשן מועברת לסוכן המרוחק.
config.enableTextStreaming

boolean

זה שינוי אופציונלי. האם להפעיל סטרימינג של פלט טקסט מהמודל. כברירת מחדל, פלט הטקסט מהמודל נאסף לפני שהוא נשלח ללקוח. הערה: האפשרות הזו נתמכת רק בסשנים של טקסט (לא קולי) דרך sessions.streamRunSession או BidiRunSession.
config.excludeDiagnosticInfo

boolean

זה שינוי אופציונלי. האם להחריג פרטי אבחון מפלט הסשן.
inputs[]

object (SessionInput)

חובה. נתונים שהוזנו לסשן.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל זרם של מופעים של RunSessionResponse.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב session:

  • ces.sessions.runSession

מידע נוסף מופיע במאמרי העזרה בנושא IAM.