Class SearchAgentsRequest
Message for searching Agents
Implements
Inherited Members
Namespace: Google.Apis.AgentRegistry.v1alpha.Data
Assembly: Google.Apis.AgentRegistry.v1alpha.dll
Syntax
public class SearchAgentsRequest : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
PageSize
Optional. The maximum number of search results to return per page. The page size is capped at 100, even if
a larger value is specified. A negative value will result in an INVALID_ARGUMENT error. If unspecified or
set to 0, a default value of 20 will be used. The server may return fewer results than requested.
Declaration
[JsonProperty("pageSize")]
public virtual int? PageSize { get; set; }
Property Value
| Type | Description |
|---|---|
| int? |
PageToken
Optional. If present, retrieve the next batch of results from the preceding call to this method.
page_token must be the value of next_page_token from the previous response. The values of all other
method parameters, must be identical to those in the previous call.
Declaration
[JsonProperty("pageToken")]
public virtual string PageToken { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
SearchString
Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all
accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable
fields, where the operators can be used along with the suffix wildcard symbol *. See
instructions for more details.
Allowed operators: =, :, NOT, AND, OR, and (). Searchable fields: | Field | = | : | * |
Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes |
Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description |
No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | |
skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags |
No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: *
agentId=urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234 to find the agent
with the specified agent ID. * name:important to find agents whose name contains important as a word. *
displayName:works* to find agents whose display name contains words that start with works. *
skills.tags:test to find agents whose skills tags contain test. * planner OR booking to find agents
whose metadata contains the words planner or booking.
Declaration
[JsonProperty("searchString")]
public virtual string SearchString { get; set; }
Property Value
| Type | Description |
|---|---|
| string |