Method: projects.locations.collections.dataConnector.buildActionInvocation

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

בקשת HTTP


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

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

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

פרמטרים
name

string

חובה. DataConnector resource.

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

גוף הבקשה

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

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

string

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

לדוגמה: "send_email"
languageCode

string

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

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "actionInvocation": {
    object (ActionInvocation)
  }
}
שדות
actionInvocation

object (ActionInvocation)

הפעלת הפעולה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.buildActionInvocation

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

ActionInvocation

מייצג הפעלה של פעולה.

ייצוג ב-JSON 
{
  "agentName": string,
  "actionName": string,
  "args": {
    object
  },
  "dataConnector": string,
  "dataSource": string,
  "invocationId": string,
  "actionDisplayName": string,
  "userConfirmationMessage": string,
  "authorizationUrl": string,
  "resendQueryOnUserAuthorization": boolean,
  "parameterDeclaration": {
    object
  },
  "argSetCandidates": [
    {
      object
    }
  ],
  "executedArgs": {
    object
  }
}
שדות
agentName

string

אופציונלי. שם הסוכן שמבצע את הפעולה.
actionName

string

שם הפעולה.

לדוגמה: send_email
args

object (Struct format)

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

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

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

אם יש כמה אפשרויות לארגומנטים של הפעולה (למשל, כמה משבצות זמן אפשריות לאירוע ביומן), השדה הזה מתאר את האפשרות הראשונה.
dataConnector

string

DataConnector resource.

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

string

פלט בלבד. השם של מקור הנתונים.
invocationId

string

פלט בלבד. מזהה הפעלת הפעולה.
actionDisplayName

string

פלט בלבד. שם הפעולה שקריא לבני אדם ומוצג למשתמש.
userConfirmationMessage

string

פלט בלבד. הודעה קריאה לאנשים שמוצגת למשתמש יחד עם תיבת הדו-שיח לאישור.
authorizationUrl

string

פלט בלבד. כתובת URL להרשאה.
resendQueryOnUserAuthorization

boolean

פלט בלבד. אם הערך הוא true, המתקשר צריך לשלוח מחדש את השאילתה אחרי שהמשתמש מאשר אותה.
parameterDeclaration

object (Struct format)

פלט בלבד. תיאור של הפרמטרים של הפעולה, כולל מידע על עיבוד או אימות. הפורמט שלו מבוסס על מפרט הפרמטרים של OpenAPI. על סמך: https://swagger.io/docs/specification/describing-parameters/

לדוגמה:

{
    "type": "object",
    "properties": {
        "title": {
            "type": "string",
            "description": "title of the event",
        },
        "startTime": {
            "type": "string",
            "format": "date-time",
            "description": (
                "Start time of the meeting, e.g. 2024-07-12T23:30"
            ),
        },
        "attendees": {
            "type": "array",
            "items": {"type": "string", "format": "email"},
            "description": "List of email addresses of attendees",
        },
        "duration": {
            "type": "integer",
            "format": "int32",
            "minimum": 5,
            "maximum": 240,
            "default": { "numberValue": 30 },
            "description": (
                "Duration of the meeting in minutes. Defaults to 30"
                " minutes."
            ),
        },
        "timezone": {
            "type": "string",
            "description": (
                'IANA time Zone Database name, e.g. "Europe/Zurich". If'
                " omitted, timezone of the user will be used"
            ),
        },
        "eventType": {
            "type": "string",
            "enum": ["meeting", "focus_time", "out_of_office", "task"],
            "description": "type of the event",
        },
    },
    "required": ["startTime", "title", "attendees"]
}
argSetCandidates[]

object (Struct format)

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

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

לדוגמה:

‫args מכיל את האפשרות הראשונה עם כל הארגומנטים:

{"title": "Meeting with John", "startTime": "2024-08-01T13:30", ... }

‫argSetCandidates מכיל את שאר האפשרויות, אבל רק הארגומנטים השונים מאוכלסים:

[{ "startTime": "2024-08-01T14:00" }, { "startTime": "2024-08-01T14:30" }, { "startTime": "2024-08-01T15:30" }]

executedArgs

object (Struct format)

פלט בלבד. מייצג את הארגומנטים ששימשו בפועל להרצה, שאולי שונו על ידי המשתמש מהארגומנטים הראשוניים.