Method: projects.locations.apps.sessions.runSession

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

בקשת HTTP

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

כתובת ה-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,
    "includeLlmThoughtSummary": boolean,
    "excludeDiagnosticInfo": boolean,
    "includeProgressUpdate": 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

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

object (SessionConfig.RemoteDialogflowQueryParameters)

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

boolean

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

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

הערה: האפשרות הזו נתמכת רק בסשנים של טקסט (לא קוליים) באמצעות sessions.streamRunSession או BidiRunSession.
config.includeLlmThoughtSummary

boolean

זה שינוי אופציונלי. אם לכלול סיכומי מחשבות של מודל שפה גדול (LLM) בפלטים של הסשן.
config.excludeDiagnosticInfo

boolean

זה שינוי אופציונלי. אם להחריג את פרטי האבחון מהפלט של הסשן.
config.includeProgressUpdate

boolean

זה שינוי אופציונלי. אם לכלול עדכון ביניים לגבי העיבוד ללקוח. אם האפשרות מופעלת, העדכון יישלח בחזרה תוך SessionOutput.progress.
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.