Example

View as Markdown

An example associated with a Supervisor Agent. Contains a question and guidelines for how the agent should respond.

Get an example from a Supervisor AgentGET /api/2.1/{name=supervisor-agents/*/examples/*}List examples for a Supervisor AgentGET /api/2.1/{parent=supervisor-agents/*}/examplesCreate an example for a Supervisor AgentPOST /api/2.1/{parent=supervisor-agents/*}/examplesUpdate an example in a Supervisor AgentPATCH /api/2.1/{name=supervisor-agents/*/examples/*}Delete an example from a Supervisor AgentDELETE /api/2.1/{name=supervisor-agents/*/examples/*}

Example object

An example associated with a Supervisor Agent. Contains a question and guidelines for how the agent should respond.

namestringBetaIDImmutable

Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

questionstringBeta

The example question.

guidelinesarray of stringBeta

Guidelines for answering the question.

example_idstringBetaOutput only

The universally unique identifier (UUID) of the example.

View as Markdown

The Example object

{
  "name": "string",
  "question": "string",
  "guidelines": [
    "string"
  ],
  "example_id": "string"
}

Get an example from a Supervisor Agent Beta

GET /api/2.1/{name=supervisor-agents/*/examples/*}

Gets an example from a Supervisor Agent.

API scopes: supervisor-agents

Parameters

namestringRequiredpath

The resource name of the example. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

Response

Returns the Example object.

View as Markdown

Response

{
  "name": "string",
  "question": "string",
  "guidelines": [
    "string"
  ],
  "example_id": "string"
}

List examples for a Supervisor Agent Beta

GET /api/2.1/{parent=supervisor-agents/*}/examples

Lists examples under a Supervisor Agent.

API scopes: supervisor-agents

Parameters

parentstringRequiredpath

Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}

page_sizeint32[ 1 .. 100 ]query

The maximum number of examples to return. If unspecified, at most 100 examples will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_tokenstringquery

A page token, received from a previous ListExamples call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

Response

Returns a list of Example objects.

View as Markdown

Response

{
  "examples": [
    {
      "name": "string",
      "question": "string",
      "guidelines": [
        "string"
      ],
      "example_id": "string"
    }
  ],
  "next_page_token": "string"
}

Create an example for a Supervisor Agent Beta

POST /api/2.1/{parent=supervisor-agents/*}/examples

Creates an example for a Supervisor Agent.

API scopes: supervisor-agents

Parameters

parentstringRequiredpath

Parent resource where this example will be created. Format: supervisor-agents/{supervisor_agent_id}

Request body

The example to create under the parent Supervisor Agent.

namestringIDImmutable

Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

questionstringRequired

The example question.

guidelinesarray of stringRequired

Guidelines for answering the question.

Response

Returns the Example object.

View as Markdown

Request

{
  "name": "string",
  "question": "string",
  "guidelines": [
    "string"
  ]
}

Response

{
  "name": "string",
  "question": "string",
  "guidelines": [
    "string"
  ],
  "example_id": "string"
}

Update an example in a Supervisor Agent Beta

PATCH /api/2.1/{name=supervisor-agents/*/examples/*}

Updates an example in a Supervisor Agent.

API scopes: supervisor-agents

Parameters

namestringRequiredpath

The resource name of the example to update. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

update_maskstringRequiredquery

Comma-delimited list of fields to update on the example. Allowed values: question, guidelines. Examples:

• question
• question,guidelines

Request body

namestringIDImmutable

Full resource name: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

questionstringRequired

The example question.

guidelinesarray of stringRequired

Guidelines for answering the question.

Response

Returns the Example object.

View as Markdown

Request

{
  "name": "string",
  "question": "string",
  "guidelines": [
    "string"
  ]
}

Response

{
  "name": "string",
  "question": "string",
  "guidelines": [
    "string"
  ],
  "example_id": "string"
}

Delete an example from a Supervisor Agent Beta

DELETE /api/2.1/{name=supervisor-agents/*/examples/*}

Deletes an example from a Supervisor Agent.

API scopes: supervisor-agents

Parameters

namestringRequiredpath

The resource name of the example to delete. Format: supervisor-agents/{supervisor_agent_id}/examples/{example_id}

View as Markdown

Response

{}