supervisoragents

type App struct {
	// App name
	Name *string `fieldmask:"name"`
}

type Client struct {
	// contains filtered or unexported fields
}

type CreateExampleRequest struct {
	// Parent resource where this example will be created. Format:
	// supervisor-agents/{supervisor_agent_id}
	Parent *string
	// The example to create under the parent Supervisor Agent.
	Example *Example
}

type CreateSupervisorAgentRequest struct {
	// The Supervisor Agent to create.
	SupervisorAgent *SupervisorAgent
}

type CreateToolRequest struct {
	// Parent resource where this tool will be created. Format:
	// supervisor-agents/{supervisor_agent_id}
	Parent *string
	Tool   *Tool
	// The ID to use for the tool, which will become the final component of the
	// tool's resource name.
	ToolId *string
}

type DeleteExampleRequest struct {
	// The resource name of the example to delete. Format:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name *string
}

type DeleteSupervisorAgentRequest struct {
	// The resource name of the Supervisor Agent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name *string
}

type DeleteToolRequest struct {
	// The resource name of the Tool. Format:
	// supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name *string
}

type Example struct {
	// Full resource name:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name *string `fieldmask:"name"`
	// The example question.
	Question *string `fieldmask:"question"`
	// Guidelines for answering the question.
	Guidelines []string `fieldmask:"guidelines"`
	// The universally unique identifier (UUID) of the example.
	ExampleId *string `fieldmask:"example_id"`
}

type GenieSpace struct {
	// Deprecated: use space_id instead. Still REQUIRED for backward compatibility
	// until a future API version removes it.
	Id *string `fieldmask:"id"`
}

type GetExampleRequest struct {
	// The resource name of the example. Format:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name *string
}

type GetSupervisorAgentRequest struct {
	// The resource name of the Supervisor Agent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name *string
}

type GetToolRequest struct {
	// The resource name of the Tool. Format:
	// supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name *string
}

type KnowledgeAssistant struct {
	// Deprecated: use knowledge_assistant_id instead.
	ServingEndpointName *string `fieldmask:"serving_endpoint_name"`
	// The ID of the knowledge assistant.
	KnowledgeAssistantId *string `fieldmask:"knowledge_assistant_id"`
}

type ListExamplesRequest struct {
	// Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}
	Parent *string
	// 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.
	PageSize *int
	// A page token, received from a previous `ListExamples` call. Provide this to
	// retrieve the subsequent page. If unspecified, the first page will be
	// returned.
	PageToken *string
}

type ListExamplesResponse struct {
	Examples      []Example
	NextPageToken *string
}

type ListSupervisorAgentsRequest struct {
	// The maximum number of supervisor agents to return. If unspecified, at most
	// 100 supervisor agents will be returned. The maximum value is 100; values
	// above 100 will be coerced to 100.
	PageSize *int
	// A page token, received from a previous `ListSupervisorAgents` call. Provide
	// this to retrieve the subsequent page. If unspecified, the first page will be
	// returned.
	PageToken *string
}

type ListSupervisorAgentsResponse struct {
	SupervisorAgents []SupervisorAgent
	// A token that can be sent as `page_token` to retrieve the next page. If this
	// field is omitted, there are no subsequent pages.
	NextPageToken *string
}

type ListToolsRequest struct {
	// Parent resource to list from. Format: supervisor-agents/{supervisor_agent_id}
	Parent    *string
	PageSize  *int
	PageToken *string
}

type ListToolsResponse struct {
	Tools         []Tool
	NextPageToken *string
}

type SupervisorAgent struct {
	// The resource name of the SupervisorAgent. Format:
	// supervisor-agents/{supervisor_agent_id}
	Name *string `fieldmask:"name"`
	// The display name of the Supervisor Agent, unique at workspace level.
	DisplayName *string `fieldmask:"display_name"`
	// Description of what this agent can do (user-facing).
	Description *string `fieldmask:"description"`
	// Optional natural-language instructions for the supervisor agent.
	Instructions *string `fieldmask:"instructions"`
	// Deprecated: Use supervisor_agent_id instead.
	Id *string `fieldmask:"id"`
	// The universally unique identifier (UUID) of the Supervisor Agent.
	SupervisorAgentId *string `fieldmask:"supervisor_agent_id"`
	// The creator of the Supervisor Agent.
	Creator *string `fieldmask:"creator"`
	// Creation timestamp.
	CreateTime *types.Time `fieldmask:"create_time"`
	// The name of the supervisor agent's serving endpoint.
	EndpointName *string `fieldmask:"endpoint_name"`
	// The MLflow experiment ID.
	ExperimentId *string `fieldmask:"experiment_id"`
}

type Tool struct {
	// Full resource name: supervisor-agents/{supervisor_agent_id}/tools/{tool_id}
	Name *string `fieldmask:"name"`
	// Deprecated: Use tool_id instead.
	Id *string `fieldmask:"id"`
	// Tool type. Must be one of: "genie_space", "knowledge_assistant",
	// "uc_function", "uc_connection", "uc_mcp", "app", "volume", "dashboard",
	// "serving_endpoint", "table", "vector_search_index", "catalog", "schema",
	// "supervisor_agent", "databricks_web_search", "skill". The legacy values
	// "lakeview_dashboard", "uc_table", and "web_search" are also accepted and
	// remain equivalent to "dashboard", "table", and "databricks_web_search"
	// respectively. The "databricks_web_search" tool_type maps to the `web_search`
	// spec field.
	ToolType *string `fieldmask:"tool_type"`
	// Specification for the tool type.
	Spec isTool_Spec
	// Description of what this tool does (user-facing).
	Description *string `fieldmask:"description"`
	// User specified id of the Tool.
	ToolId *string `fieldmask:"tool_id"`
	// contains filtered or unexported fields
}

type Tool_Spec_App struct {
	App App `fieldmask:"app"`
}

type Tool_Spec_GenieSpace struct {
	GenieSpace GenieSpace `fieldmask:"genie_space"`
}

type Tool_Spec_KnowledgeAssistant struct {
	KnowledgeAssistant KnowledgeAssistant `fieldmask:"knowledge_assistant"`
}

type Tool_Spec_UcConnection struct {
	UcConnection UcConnection `fieldmask:"uc_connection"`
}

type Tool_Spec_UcFunction struct {
	UcFunction UcFunction `fieldmask:"uc_function"`
}

type Tool_Spec_Volume struct {
	Volume Volume `fieldmask:"volume"`
}

type UcConnection struct {
	Name *string `fieldmask:"name"`
}

type UcFunction struct {
	// Full uc function name
	Name *string `fieldmask:"name"`
}

type UpdateExampleRequest struct {
	// The resource name of the example to update. Format:
	// supervisor-agents/{supervisor_agent_id}/examples/{example_id}
	Name    *string
	Example *Example
	// Comma-delimited list of fields to update on the example. Allowed values:
	// `question`, `guidelines`. Examples: - `question` - `question,guidelines`
	UpdateMask *types.FieldMask[Example]
}

type UpdateSupervisorAgentRequest struct {
	// The SupervisorAgent to update.
	SupervisorAgent *SupervisorAgent
	// Field mask for fields to be updated.
	UpdateMask *types.FieldMask[SupervisorAgent]
}

type UpdateToolRequest struct {
	// The Tool to update.
	Tool *Tool
	// Field mask for fields to be updated.
	UpdateMask *types.FieldMask[Tool]
}

type Volume struct {
	// Full uc volume name
	Name *string `fieldmask:"name"`
}