Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1336218221.3 KB
projects

Creates a new example in the given app.

post/v1/{+parent}/examples

Path parameters

parentstring required

Required. The resource name of the app to create an example in.

Query parameters

exampleIdstring

Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.

Request body

namestring

Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}

entryAgentstring

Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

displayNamestring

Required. Display name of the example.

descriptionstring

Optional. Human-readable description of the example.

updateTimestring google-datetime

Output only. Timestamp when the example was last updated.

createTimestring google-datetime

Output only. Timestamp when the example was created.

invalidboolean

Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.

etagstring

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Response

Successful response