Method: projects.locations.collections.dataConnector.executeAction

מבצע פעולה של צד שלישי באמצעות DataConnector.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:executeAction

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

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

פרמטרים
name

string

חובה. DataConnector resource.

מחבר הנתונים שמשמש להפעלת הפעולה.

גוף הבקשה

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

ייצוג ב-JSON 
{
  "actionName": string,
  "args": {
    object
  },
  "languageCode": string,
  "assistAnswerInfo": {
    object (AssistAnswerInfo)
  }
}
שדות
actionName

string

חובה. שם הפעולה.

לדוגמה: "send_email"
args

object (Struct format)

חובה. ארגומנטים בעלי שם של הפעולה.

לדוגמה: {"recipient": "tom@...", "subject": ... }

יכול להיות שהמשתמש יוכל לערוך את החלק הזה.
languageCode

string

זה שינוי אופציונלי. השפה שבה יוצגו הודעות הסטטוס והשגיאות שנוצרות על ידי הפעולות.
assistAnswerInfo

object (AssistAnswerInfo)

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

משאב העזרה שאליו מתייחסים בתשובה חייב להתקיים.

גוף התשובה

תשובה לשיטה DataConnectorService.ExecuteAction.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "status": {
    object (Status)
  },
  "textResult": string,
  "result": {
    object
  }
}
שדות
status

object (Status)

הסטטוס של ביצוע הפעולה.
textResult

string

תוצאה קריאה לאנשים של הרצת הפעולה במקרה של הצלחה.
result

object (Struct format)

תוצאה מפורטת של הרצת הפעולה במקרה של הצלחה.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

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

הרשאות IAM

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

  • discoveryengine.dataConnectors.executeAction

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

AssistAnswerInfo

הודעה שמזהה הפעלה של פעולה בתשובה של העזרה.

ייצוג ב-JSON 
{
  "assistAnswer": string,
  "invocationId": string
}
שדות
assistAnswer

string

חובה. שם התשובה שנוצרה בעזרת AI.

פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}
invocationId

string

חובה. מזהה הפעלת הפעולה.