Discovery Engine API . projects . locations . collections . engines . assistants . agents

Instance Methods

message()

Returns the message Resource.

operations()

Returns the operations Resource.

tasks()

Returns the tasks Resource.

close()

Close httplib2 connections.

getCard(tenant, x__xgafv=None)

GetAgentCard returns the agent card for the agent.

Method Details

close()
Close httplib2 connections.
getCard(tenant, x__xgafv=None)
GetAgentCard returns the agent card for the agent.

Args:
  tenant: string, Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # AgentCard conveys key information: - Overall details (version, name, description, uses) - Skills; a set of actions/solutions the agent can perform - Default modalities/content types supported by the agent. - Authentication requirements Next ID: 19
  "additionalInterfaces": [ # Announcement of additional supported transports. Client can use any of the supported transports.
    { # Defines additional transport information for the agent.
      "tenant": "A String", # Tenant to be set in the request when calling the agent. Experimental, might still change for 1.0 release.
      "transport": "A String", # The transport supported this url. This is an open form string, to be easily extended for many transport protocols. The core ones officially supported are JSONRPC, GRPC and HTTP+JSON.
      "url": "A String", # The url this interface is found at.
    },
  ],
  "capabilities": { # Defines the A2A feature set supported by the agent # A2A Capability set supported by the agent.
    "extensions": [ # Extensions supported by this agent.
      { # A declaration of an extension supported by an Agent.
        "description": "A String", # A description of how this agent uses this extension. Example: "Google OAuth 2.0 authentication"
        "params": { # Optional configuration for the extension.
          "a_key": "", # Properties of the object.
        },
        "required": True or False, # Whether the client must follow specific requirements of the extension. Example: false
        "uri": "A String", # The URI of the extension. Example: "https://developers.google.com/identity/protocols/oauth2"
      },
    ],
    "pushNotifications": True or False, # If the agent can send push notifications to the clients webhook
    "streaming": True or False, # If the agent will support streaming responses
  },
  "defaultInputModes": [ # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED The set of interaction modes that the agent supports across all skills. This can be overridden per skill. Defined as mime types.
    "A String",
  ],
  "defaultOutputModes": [ # The mime types supported as outputs from this agent.
    "A String",
  ],
  "description": "A String", # A description of the agent's domain of action/solution space. Example: "Agent that helps users with recipes and cooking."
  "documentationUrl": "A String", # A url to provide additional documentation about the agent.
  "iconUrl": "A String", # An optional URL to an icon for the agent.
  "name": "A String", # A human readable name for the agent. Example: "Recipe Agent"
  "preferredTransport": "A String", # The transport of the preferred endpoint. If empty, defaults to JSONRPC.
  "protocolVersion": "A String", # The version of the A2A protocol this agent supports.
  "provider": { # Represents information about the service provider of an agent. # The service provider of the agent.
    "organization": "A String", # The providers organization name Example: "Google"
    "url": "A String", # The providers reference url Example: "https://ai.google.dev"
  },
  "security": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security requirements for contacting the agent. This list can be seen as an OR of ANDs. Each object in the list describes one possible set of security requirements that must be present on a request. This allows specifying, for example, "callers must either use OAuth OR an API Key AND mTLS." Example: security { schemes { key: "oauth" value { list: ["read"] } } } security { schemes { key: "api-key" } schemes { key: "mtls" } }
    {
      "schemes": {
        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
          "list": [
            "A String",
          ],
        },
      },
    },
  ],
  "securitySchemes": { # The security scheme details used for authenticating with this agent.
    "a_key": {
      "apiKeySecurityScheme": {
        "description": "A String", # Description of this security scheme.
        "location": "A String", # Location of the API key, valid values are "query", "header", or "cookie"
        "name": "A String", # Name of the header, query or cookie parameter to be used.
      },
      "httpAuthSecurityScheme": {
        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
        "description": "A String", # Description of this security scheme.
        "scheme": "A String", # The name of the HTTP Authentication scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry. The value is case-insensitive, as defined in RFC7235.
      },
      "mtlsSecurityScheme": {
        "description": "A String", # Description of this security scheme.
      },
      "oauth2SecurityScheme": {
        "description": "A String", # Description of this security scheme.
        "flows": { # An object containing configuration information for the flow types supported
          "authorizationCode": {
            "authorizationUrl": "A String", # The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS
            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
            "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
              "a_key": "A String",
            },
            "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
          },
          "clientCredentials": {
            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
            "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
              "a_key": "A String",
            },
            "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
          },
          "implicit": {
            "authorizationUrl": "A String", # The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS
            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
            "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
              "a_key": "A String",
            },
          },
          "password": {
            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
            "scopes": { # The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty.
              "a_key": "A String",
            },
            "tokenUrl": "A String", # The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS.
          },
        },
        "oauth2MetadataUrl": "A String", # URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
      },
      "openIdConnectSecurityScheme": {
        "description": "A String", # Description of this security scheme.
        "openIdConnectUrl": "A String", # Well-known URL to discover the [[OpenID-Connect-Discovery]] provider metadata.
      },
    },
  },
  "signatures": [ # JSON Web Signatures computed for this AgentCard.
    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
      "header": { # The unprotected JWS header values.
        "a_key": "", # Properties of the object.
      },
      "protected": "A String", # Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object. Required.
      "signature": "A String", # Required. The computed signature, base64url-encoded. Required.
    },
  ],
  "skills": [ # Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at.
    { # AgentSkill represents a unit of action/solution that the agent can perform. One can think of this as a type of highly reliable solution that an agent can be tasked to provide. Agents have the autonomy to choose how and when to use specific skills, but clients should have confidence that if the skill is defined that unit of action can be reliably performed.
      "description": "A String", # A human (or llm) readable description of the skill details and behaviors.
      "examples": [ # A set of example queries that this skill is designed to address. These examples should help the caller to understand how to craft requests to the agent to achieve specific goals. Example: ["I need a recipe for bread"]
        "A String",
      ],
      "id": "A String", # Unique identifier of the skill within this agent.
      "inputModes": [ # Possible input modalities supported.
        "A String",
      ],
      "name": "A String", # A human readable name for the skill.
      "outputModes": [ # Possible output modalities produced
        "A String",
      ],
      "security": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED Security schemes necessary for the agent to leverage this skill. As in the overall AgentCard.security, this list represents a logical OR of security requirement objects. Each object is a set of security schemes that must be used together (a logical AND). protolint:enable REPEATED_FIELD_NAMES_PLURALIZED
        {
          "schemes": {
            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED
              "list": [
                "A String",
              ],
            },
          },
        },
      ],
      "tags": [ # A set of tags for the skill to enhance categorization/utilization. Example: ["cooking", "customer support", "billing"]
        "A String",
      ],
    },
  ],
  "supportsAuthenticatedExtendedCard": True or False, # Whether the agent supports providing an extended agent card when the user is authenticated, i.e. is the card from .well-known different than the card from GetAgentCard.
  "url": "A String", # A URL to the address the agent is hosted at. This represents the preferred endpoint as declared by the agent.
  "version": "A String", # The version of the agent. Example: "1.0.0"
}