Extensions API

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

‫Vertex AI מספק את Extension API, שמאפשר לרשום, לנהל ולהפעיל תוספים. ‫Vertex AI מספק גם קבוצה של תוספים מוכנים מראש מ-Extension API, כולל התוסף code interpreter והתוסף חיפוש מבוסס סוכנים.

מגבלות

‫Extension API זמין רק באזור us-central1.

תחביר לדוגמה

תחביר ליצירת משאב של תוסף.

curl

curl -X POST \

-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \

https://${LOCATION}-aiplatform.googleapis.com/v1beta1/projects/${PROJECT_ID}/locations/${LOCATION}/extensions:import \
-d '{
  "displayName": "...",
  "description": "...",
  "manifest": {
    ...
    "apiSpec": {
      ...
    },
    "authConfig": {
      ...
    }
    ...
  }
}'

Python

from vertexai.preview import extensions

extensions.Extension.create(
  manifest: Union[JsonDict, ExtensionManifest],
  display_name: Optional[str] = None,
  description: Optional[str] = None,
  runtime_config: Optional[Union[JsonDict, RuntimeConfig]] = None
)

רשימת הפרמטרים

גוף הבקשה

פרמטרים

displayName

string (אופציונלי)

שם התצוגה של התוסף שמוצג למשתמשים מה-API ומממשק המשתמש. הערך צריך להיות מחרוזת UTF-8 באורך של עד 128 תווים.

description

string (אופציונלי)

התיאור של התוסף שמוצג למשתמשים מה-API ומממשק המשתמש. הערך הזה צריך להיות מחרוזת UTF-8 בגודל של עד 1MB.

manifest

JsonDict|ExtensionManifest

המניפסט של התוסף.

runtimeConfig

JsonDict|RuntimeConfig (אופציונלי)

הגדרות זמן הריצה שקובעות את ההתנהגות של התוסף בזמן הריצה.

בתוסף 'מפענח קוד', הפורמט הוא:

  "runtimeConfig": {
    "codeInterpreterRuntimeConfig": {
        "fileInputGcsBucket": string,
        "fileOutputGcsBucket": string
    }
  }

בתוסף חיפוש מבוסס סוכנים, הפורמט הוא: 

  "runtimeConfig": {
    "vertexAiSearchRuntimeConfig": {
      "servingConfigName": string,
    }
  }

manifest

המניפסט של התוסף.

פרמטרים

name

string

השם של התוסף שמשמש את ה-LLM לחשיבה רציונלית. הערך צריך להיות מחרוזת UTF-8 באורך של עד 128 תווים.

description

string

תיאור בשפה טבעית של השימוש בתוסף. התיאור מוצג ל-LLM כדי לעזור לו לבצע ניתוח.התיאור צריך להיות מחרוזת UTF-8 באורך של עד 1MB.

apiSpec

ApiSpec

מפרט ה-API שמוצג ל-LLM לצורך הסקת מסקנות. חשוב לספק תיאור משמעותי ואינפורמטיבי. ‫apiSpec מכיל את ההפניה ל-URI של Cloud Storage שבו מאוחסן קובץ ה-yaml של OpenAPI. 

  "apiSpec": {
    "openApiGcsUri": string
  }

authConfig

JsonDict|AuthConfig

סוג האימות שהתוסף הזה תומך בו.

בקשה לייבוא תוסף חייבת לכלול הגדרת אימות.

"authConfig": {
  "authType": "GOOGLE_SERVICE_ACCOUNT_AUTH",
  "googleServiceAccountConfig": {
    "serviceAccount": string
  },
}

apiSpec

מפרט ה-API שמוצג ל-LLM לצורך הסקת מסקנות.

פרמטרים

openApiGcsUri

string

מזהה URI של Cloud Storage של קובץ ה-YAML של OpenAPI שמתאר את API התוסף, כמו gs://vertex-extension-public/code_interpreter.yaml

authConfig

סוג האימות שנתמך על ידי התוסף הזה.

פרמטרים

authType

string

שיטת האימות. ערכים נתמכים: GOOGLE_SERVICE_ACCOUNT_AUTH.

googleServiceAccountConfig

תוסף מפענח הקוד ותוסף חיפוש מבוסס-Vertex AI תומכים רק באימות של חשבון שירות של Google, שבו Vertex AI משתמש בסוכן שירות של שירות התוספים של Vertex AI כדי לגשת לממשקי ה-API.

פרמטרים

serviceAccount

string (אופציונלי)

חשבון השירות שדרכו מופעלת ההרחבה. אם מציינים חשבון שירות, צריך להעניק את ההרשאה iam.serviceAccounts.getAccessToken לסוכן שירות של Vertex AI Extensions בחשבון השירות שצוין. אם לא מציינים סוכן, נעשה שימוש בסוכן של שירות התוספים של Vertex AI כדי להפעיל את התוסף.

runtimeConfig

האובייקט runtimeConfig מכיל הגדרות נוספות שמשמשות להרצת התוסף.

תוסף לניתוח קוד

פרמטרים

fileInputGcsBucket

string (אופציונלי)

הקטגוריה של Cloud Storage לקובץ הקלט של התוסף. צריך להעניק לסוכן השירות של Vertex Extension Custom Code את ההרשאה roles/storage.objectViewer לדלי הזה. אם לא מציינים, התוסף מקבל רק תוכן קובץ מגוף הבקשה ודוחה קבצים ב-Cloud Storage.

fileOutputGcsBucket

string (אופציונלי)

הקטגוריה ב-Cloud Storage שאליה מועבר קובץ הפלט מהתוסף. צריך להעניק לסוכן השירות של Vertex Extension Custom Code את ההרשאה roles/storage.objectUser לדלי הזה. אם לא מציינים קובץ, תוכן הקובץ מופיע בגוף התשובה.

תוסף חיפוש מבוסס סוכנים

פרמטרים

servingConfigName

string

שם ההגדרה של חיפוש מבוסס סוכנים שמשמשת את התוסף. פורמט:

projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}

הפעלת התוסף

פרמטרים

operation_id

string

המזהה שנבחר של הפעולה שתבוצע בתוסף הזה.

operation_params

JsonDict|Struct (אופציונלי)

פרמטרים של בקשות שמשמשים להפעלת הפעולה הזו. ה-JSON צריך להיות בצורה של מיפוי עם שם הפרמטר כמפתח וערך הפרמטר בפועל כערך. לדוגמה, כדי להגדיר פרמטר בשם query למחרוזת What is Vertex AI?, אפשר להשתמש ב-{"query": "What is Vertex AI?"}.

דוגמאות

ייבוא תוסף של מתורגמן קוד

יוצרים או רושמים משאב של תוסף.

בדוגמה הזו אפשר לראות איך מייבאים תוסף של מתורגמן קוד.

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • ‫PROJECT_ID: מזהה הפרויקט.
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫DISPLAY_NAME: השם המוצג של התוסף שמוצג למשתמשים ב-API ובממשק המשתמש. הערך צריך להיות מחרוזת UTF-8 באורך של עד 128 תווים.
  • ‫DESCRIPTION: תיאור התוסף שמוצג למשתמשים ב-API ובממשק המשתמש. הערך הזה צריך להיות מחרוזת UTF-8 בגודל של עד 1MB.
  • ‫MANIFEST_NAME: שם התוסף שמשמש את ה-LLM לניתוח. המחרוזת צריכה להיות בקידוד UTF-8, באורך של עד 128 תווים
  • ‫MANIFEST_DESCRIPTION: תיאור בשפה טבעית שמוצג למודל שפה גדול (LLM). התיאור צריך לכלול את אופן השימוש בתוסף, והוא חיוני כדי שה-LLM יוכל לבצע ניתוח. הערך הזה צריך להיות מחרוזת UTF-8 בגודל של עד 1MB.
  • ‫GCS_URI: ה-URI של Cloud Storage של קובץ ה-YAML של OpenAPI שמתאר את ה-API של התוסף.
  • ‫AUTH_TYPE: שיטת אימות. ערכים נתמכים: GOOGLE_SERVICE_ACCOUNT_AUTH.

ה-method של ה-HTTP וכתובת ה-URL: 

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions:import

גוף בקשת JSON: 

{
  "displayName": "DISPLAY_NAME",
  "description": "DESCRIPTION",
  "manifest": {
    "name": "NAME",
    "description": "MANIFEST_DESCRIPTION",
    "apiSpec": {
      "openApiGcsUri": "GCS_URI",
    },
    "authConfig": {
      "authType": "AUTH_TYPE",
      "googleServiceAccountConfig": {}
    }
  }
}

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

curl

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions:import"

PowerShell

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions:import" | Select-Object -Expand Content

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של Python API. 

import vertexai
from vertexai.preview import extensions

# TODO(developer): Update and un-comment below line
# PROJECT_ID = "your-project-id"
vertexai.init(project=PROJECT_ID, location="us-central1")

extension = extensions.Extension.create(
    display_name="Code Interpreter",
    description="This extension generates and executes code in the specified language",
    manifest={
        "name": "code_interpreter_tool",
        "description": "Google Code Interpreter Extension",
        "api_spec": {
            "open_api_gcs_uri": "gs://vertex-extension-public/code_interpreter.yaml"
        },
        "auth_config": {
            "google_service_account_config": {},
            "auth_type": "GOOGLE_SERVICE_ACCOUNT_AUTH",
        },
    },
)
print(extension.resource_name)
# Example response:
# projects/123456789012/locations/us-central1/extensions/12345678901234567

ייבוא עם הגדרות זמן ריצה

יוצרים או רושמים משאב של תוסף.

בדוגמה הזו מוצג ייבוא של תוסף חיפוש מבוסס סוכנים על ידי ציון RuntimeConfig.

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • PROJECT_ID: .
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫DISPLAY_NAME: השם המוצג של התוסף שמוצג למשתמשים ב-API ובממשק המשתמש. הערך צריך להיות מחרוזת UTF-8 באורך של עד 128 תווים.
  • ‫DESCRIPTION: תיאור התוסף שמוצג למשתמשים ב-API ובממשק המשתמש. הערך הזה צריך להיות מחרוזת UTF-8 בגודל של עד 1MB.
  • ‫MANIFEST_NAME: שם התוסף שמשמש את ה-LLM לניתוח. המחרוזת צריכה להיות בקידוד UTF-8, באורך של עד 128 תווים
  • ‫MANIFEST_DESCRIPTION: תיאור בשפה טבעית שמוצג למודל שפה גדול (LLM). התיאור צריך לכלול את אופן השימוש בתוסף, והוא חיוני כדי שה-LLM יוכל לבצע ניתוח. הערך הזה צריך להיות מחרוזת UTF-8 בגודל של עד 1MB.
  • ‫GCS_URI: ה-URI של Cloud Storage של קובץ ה-YAML של OpenAPI שמתאר את ה-API של התוסף.
  • ‫AUTH_TYPE: שיטת אימות. ערכים נתמכים: GOOGLE_SERVICE_ACCOUNT_AUTH.
  • ‫SERVING_CONFIG_NAME: שם הגדרת ההפעלה של חיפוש מבוסס-Vertex AI, כדי לציין באיזה משאב של חיפוש מבוסס-Vertex AI התוסף משתמש. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}

ה-method של ה-HTTP וכתובת ה-URL: 

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions:import

גוף בקשת JSON: 

{
  "displayName": "DISPLAY_NAME",
  "description": "DESCRIPTION",
  "manifest": {
    "name": "NAME",
    "description": "MANIFEST_DESCRIPTION",
    "apiSpec": {
      "openApiGcsUri": "GCS_URI",
    },
    "authConfig": {
      "authType": "AUTH_TYPE",
      "googleServiceAccountConfig": {}
    },
    runtime_config={
      "vertex_ai_search_runtime_config": {
          "serving_config_name": SERVING_CONFIG_NAME,
      }
    }
  }
}

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

curl

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions:import"

PowerShell

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions:import" | Select-Object -Expand Content

Python

import vertexai
from vertexai.preview import extensions

vertexai.init(project=PROJECT_ID, location=LOCATION)

extension_vertex_ai_search = extensions.Extension.create(
    display_name = "vertex_ai_search",
    description = "This extension search from provided datastore",
    manifest = {
        "name": "vertex_ai_search",
        "description": "Google Vertex AI Search Extension",
        "api_spec": {
            "open_api_gcs_uri": "gs://vertex-extension-public/vertex_ai_search.yaml"
        },
        "auth_config": {
            "google_service_account_config": {},
            "auth_type": "GOOGLE_SERVICE_ACCOUNT_AUTH",
        },
    },
    runtime_config={
        "vertex_ai_search_runtime_config": {
            "serving_config_name": SERVING_CONFIG_NAME,
        }
    }
)

הפעלת תוסף

כדי להפעיל תוסף, קוראים ישירות לתוסף ומספקים את פרמטרי ההפעלה בבקשה.

בדוגמה הזו, התוסף generate_and_execute של מפענח הקוד מופעל כדי לקבל את התשובה לשאילתה find the max value in the list: [1,2,3,4,-5].

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • PROJECT_ID: .
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫EXTENSION_ID: מזהה התוסף.
  • ‫OPERATION_ID: המזהה שנבחר של הפעולה שתבוצע בתוסף הזה.
  • ‫QUERY: פרמטרים של הבקשה להפעלת הפעולה בפורמט של זוגות מפתח/ערך, {"query": "What is Vertex AI?"}.

ה-method של ה-HTTP וכתובת ה-URL: 

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID:execute

גוף בקשת JSON: 

{
  "operation_id": "OPERATION_ID",
  "operation_params": {
    "query": "QUERY",
  }
}

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

curl

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID:execute"

PowerShell

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID:execute" | Select-Object -Expand Content

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של Python API. 

import vertexai
from vertexai.preview import extensions

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# extension_id = "your-extension-id"
vertexai.init(project=PROJECT_ID, location="us-central1")

extension = extensions.Extension(extension_id)

response = extension.execute(
    operation_id="generate_and_execute",
    operation_params={"query": "find the max value in the list: [1,2,3,4,-5]"},
)
print(response)
# Example response:
# {
#     "generated_code": "```python\n# Find the maximum value in the list\ndata = [1, 2,..", ..
#     "execution_result": "The maximum value in the list is: 4\n",
#     "execution_error": "",
#     "output_files": [],
# }

הצגת רשימה של תוספים

הצגת רשימה של התוספים בפרויקט.

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • PROJECT_ID: .
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫EXTENSION_ID: מזהה התוסף.

ה-method של ה-HTTP וכתובת ה-URL: 

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions

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

curl

מריצים את הפקודה הבאה: 

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions"

PowerShell

מריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions" | Select-Object -Expand Content

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של Python API. 

import vertexai
from vertexai.preview import extensions

# TODO (developer):Update project_id
# PROJECT_ID = "your-project-id"
vertexai.init(project=PROJECT_ID, location="us-central1")

extensions_list = extensions.Extension.list()
print(extensions_list)
# Example response:
# [<vertexai.extensions._extensions.Extension object at 0x76e8ced37af0>
# resource name: projects/[PROJECT_ID]/locations/us-central1/extensions/1234567890123456]

הורדת תוסף

קבלת פרטים על תוסף

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • PROJECT_ID: .
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫EXTENSION_ID: מזהה התוסף.

ה-method של ה-HTTP וכתובת ה-URL: 

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID

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

curl

מריצים את הפקודה הבאה: 

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID"

PowerShell

מריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID" | Select-Object -Expand Content

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של Python API. 

import vertexai
from vertexai.preview import extensions

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# extension_id = "your-extension-id"
vertexai.init(project=PROJECT_ID, location="us-central1")

extension = extensions.Extension(extension_id)
print(extension.resource_name)
# Example response:
# projects/[PROJECT_ID]/locations/us-central1/extensions/12345678901234567

עדכון תוסף

מעדכנים תוסף.

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • PROJECT_ID: .
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫EXTENSION_ID: מזהה התוסף.
  • ‫UPDATE_MASK: הפרמטר לעדכון. ערכים קבילים: displayName,‏ description או toolUseExamples.

ה-method של ה-HTTP וכתובת ה-URL: 

PATCH https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID?update_mask="UPDATE_MASK"

גוף בקשת JSON: 

{
  "description": "UPDATE_MASK",
}

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

curl

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID?update_mask="UPDATE_MASK""

PowerShell

שומרים את גוף הבקשה בקובץ בשם request.json ומריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID?update_mask="UPDATE_MASK"" | Select-Object -Expand Content

מחיקת התוסף

מחיקת תוסף.

בדוגמה הזו נמחק התוסף שמשויך למזהה התוסף.

REST

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

  • PROJECT_ID: .
  • ‫LOCATION: האזור שבו הבקשה תעובד.
  • ‫EXTENSION_ID: מזהה התוסף.

ה-method של ה-HTTP וכתובת ה-URL: 

DELETE https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID

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

curl

מריצים את הפקודה הבאה: 

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID"

PowerShell

מריצים את הפקודה הבאה: 

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/extensions/EXTENSION_ID" | Select-Object -Expand Content

Python

במאמר התקנת Vertex AI SDK ל-Python מוסבר איך להתקין או לעדכן את Vertex AI SDK ל-Python. מידע נוסף מופיע ב מאמרי העזרה של Python API. 

import vertexai
from vertexai.preview import extensions

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"
# extension_id = "extension_id"
vertexai.init(project=PROJECT_ID, location="us-central1")

extension = extensions.Extension(extension_id)
extension.delete()
# Example response:
# ...
# Extension resource projects/[PROJECT_ID]/locations/us-central1/extensions/[extension_id] deleted.

המאמרים הבאים