knowledgeassistants

type CreateExampleRequest struct {
	// The example to create under the parent Knowledge Assistant.
	Example Example `json:"example"`
	// Parent resource where this example will be created. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Parent string `json:"-" url:"-"`
}

type CreateKnowledgeAssistantRequest struct {
	// The Knowledge Assistant to create.
	KnowledgeAssistant KnowledgeAssistant `json:"knowledge_assistant"`
}

type CreateKnowledgeSourceRequest struct {
	KnowledgeSource KnowledgeSource `json:"knowledge_source"`
	// Parent resource where this source will be created. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Parent string `json:"-" url:"-"`
}

type DeleteExampleRequest struct {
	// The resource name of the example to delete. Format:
	// knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
	Name string `json:"-" url:"-"`
}

type DeleteKnowledgeAssistantRequest struct {
	// The resource name of the knowledge assistant to be deleted. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Name string `json:"-" url:"-"`
}

type DeleteKnowledgeSourceRequest struct {
	// The resource name of the Knowledge Source to delete. Format:
	// knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
	Name string `json:"-" url:"-"`
}

type Example struct {
	// Timestamp when this example was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// The universally unique identifier (UUID) of the example.
	ExampleId string `json:"example_id,omitempty"`
	// Guidelines for answering the question.
	Guidelines []string `json:"guidelines"`
	// Full resource name:
	// knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
	Name string `json:"name,omitempty"`
	// The example question.
	Question string `json:"question"`
	// Timestamp when this example was last updated.
	UpdateTime *time.Time `json:"update_time,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type FileTableSpec struct {
	// The name of the column containing BINARY file content to be indexed.
	FileCol string `json:"file_col"`
	// Full UC name of the table, in the format of
	// {CATALOG}.{SCHEMA}.{TABLE_NAME}.
	TableName string `json:"table_name"`
}

type FilesSpec struct {
	// A UC volume path that includes a list of files.
	Path string `json:"path"`
}

type GetExampleRequest struct {
	// The resource name of the example. Format:
	// knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
	Name string `json:"-" url:"-"`
}

type GetKnowledgeAssistantPermissionLevelsRequest struct {
	// The knowledge assistant for which to get or manage permissions.
	KnowledgeAssistantId string `json:"-" url:"-"`
}

type GetKnowledgeAssistantPermissionLevelsResponse struct {
	// Specific permission levels
	PermissionLevels []KnowledgeAssistantPermissionsDescription `json:"permission_levels,omitempty"`
}

type GetKnowledgeAssistantPermissionsRequest struct {
	// The knowledge assistant for which to get or manage permissions.
	KnowledgeAssistantId string `json:"-" url:"-"`
}

type GetKnowledgeAssistantRequest struct {
	// The resource name of the knowledge assistant. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Name string `json:"-" url:"-"`
}

type GetKnowledgeSourceRequest struct {
	// The resource name of the Knowledge Source. Format:
	// knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
	Name string `json:"-" url:"-"`
}

type IndexSpec struct {
	// The column that specifies a link or reference to where the information
	// came from.
	DocUriCol string `json:"doc_uri_col"`
	// Full UC name of the vector search index, in the format of
	// {CATALOG}.{SCHEMA}.{INDEX_NAME}.
	IndexName string `json:"index_name"`
	// The column that includes the document text for retrieval.
	TextCol string `json:"text_col"`
}

type KnowledgeAssistant struct {
	// Creation timestamp.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// The creator of the Knowledge Assistant.
	Creator string `json:"creator,omitempty"`
	// Description of what this agent can do (user-facing). Required when
	// creating a Knowledge Assistant. When updating a Knowledge Assistant,
	// optional unless included in update_mask.
	Description string `json:"description"`
	// The display name of the Knowledge Assistant, unique at workspace level.
	// Required when creating a Knowledge Assistant. When updating a Knowledge
	// Assistant, optional unless included in update_mask.
	DisplayName string `json:"display_name"`
	// The name of the knowledge assistant agent endpoint.
	EndpointName string `json:"endpoint_name,omitempty"`
	// Error details when the Knowledge Assistant is in FAILED state.
	ErrorInfo string `json:"error_info,omitempty"`
	// The MLflow experiment ID.
	ExperimentId string `json:"experiment_id,omitempty"`
	// The universally unique identifier (UUID) of the Knowledge Assistant.
	Id string `json:"id,omitempty"`
	// Additional global instructions on how the agent should generate answers.
	// Optional on create and update. When updating a Knowledge Assistant,
	// include this field in update_mask to modify it.
	Instructions string `json:"instructions,omitempty"`
	// The resource name of the Knowledge Assistant. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Name string `json:"name,omitempty"`
	// State of the Knowledge Assistant. Not returned in List responses.
	State KnowledgeAssistantState `json:"state,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeAssistantAccessControlRequest struct {
	// name of the group
	GroupName string `json:"group_name,omitempty"`

	PermissionLevel KnowledgeAssistantPermissionLevel `json:"permission_level,omitempty"`
	// application ID of a service principal
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	UserName string `json:"user_name,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeAssistantAccessControlResponse struct {
	// All permissions.
	AllPermissions []KnowledgeAssistantPermission `json:"all_permissions,omitempty"`
	// Display name of the user or service principal.
	DisplayName string `json:"display_name,omitempty"`
	// name of the group
	GroupName string `json:"group_name,omitempty"`
	// Name of the service principal.
	ServicePrincipalName string `json:"service_principal_name,omitempty"`
	// name of the user
	UserName string `json:"user_name,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeAssistantPermission struct {
	Inherited bool `json:"inherited,omitempty"`

	InheritedFromObject []string `json:"inherited_from_object,omitempty"`

	PermissionLevel KnowledgeAssistantPermissionLevel `json:"permission_level,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeAssistantPermissionLevel string

type KnowledgeAssistantPermissions struct {
	AccessControlList []KnowledgeAssistantAccessControlResponse `json:"access_control_list,omitempty"`

	ObjectId string `json:"object_id,omitempty"`

	ObjectType string `json:"object_type,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeAssistantPermissionsDescription struct {
	Description string `json:"description,omitempty"`

	PermissionLevel KnowledgeAssistantPermissionLevel `json:"permission_level,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeAssistantPermissionsRequest struct {
	AccessControlList []KnowledgeAssistantAccessControlRequest `json:"access_control_list,omitempty"`
	// The knowledge assistant for which to get or manage permissions.
	KnowledgeAssistantId string `json:"-" url:"-"`
}

type KnowledgeAssistantState string

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

type KnowledgeAssistantsInterface interface {

	// Creates an example for a Knowledge Assistant.
	CreateExample(ctx context.Context, request CreateExampleRequest) (*Example, error)

	// Creates a Knowledge Assistant.
	CreateKnowledgeAssistant(ctx context.Context, request CreateKnowledgeAssistantRequest) (*KnowledgeAssistant, error)

	// Creates a Knowledge Source under a Knowledge Assistant.
	CreateKnowledgeSource(ctx context.Context, request CreateKnowledgeSourceRequest) (*KnowledgeSource, error)

	// Deletes an example from a Knowledge Assistant.
	DeleteExample(ctx context.Context, request DeleteExampleRequest) error

	// Deletes a Knowledge Assistant.
	DeleteKnowledgeAssistant(ctx context.Context, request DeleteKnowledgeAssistantRequest) error

	// Deletes a Knowledge Source.
	DeleteKnowledgeSource(ctx context.Context, request DeleteKnowledgeSourceRequest) error

	// Gets an example from a Knowledge Assistant.
	GetExample(ctx context.Context, request GetExampleRequest) (*Example, error)

	// Gets a Knowledge Assistant.
	GetKnowledgeAssistant(ctx context.Context, request GetKnowledgeAssistantRequest) (*KnowledgeAssistant, error)

	// Gets a Knowledge Source.
	GetKnowledgeSource(ctx context.Context, request GetKnowledgeSourceRequest) (*KnowledgeSource, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevels(ctx context.Context, request GetKnowledgeAssistantPermissionLevelsRequest) (*GetKnowledgeAssistantPermissionLevelsResponse, error)

	// Gets the permission levels that a user can have on an object.
	GetPermissionLevelsByKnowledgeAssistantId(ctx context.Context, knowledgeAssistantId string) (*GetKnowledgeAssistantPermissionLevelsResponse, error)

	// Gets the permissions of a knowledge assistant. Knowledge assistants can
	// inherit permissions from their root object.
	GetPermissions(ctx context.Context, request GetKnowledgeAssistantPermissionsRequest) (*KnowledgeAssistantPermissions, error)

	// Gets the permissions of a knowledge assistant. Knowledge assistants can
	// inherit permissions from their root object.
	GetPermissionsByKnowledgeAssistantId(ctx context.Context, knowledgeAssistantId string) (*KnowledgeAssistantPermissions, error)

	// Lists examples under a Knowledge Assistant.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExamples(ctx context.Context, request ListExamplesRequest) listing.Iterator[Example]

	// Lists examples under a Knowledge Assistant.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExamplesAll(ctx context.Context, request ListExamplesRequest) ([]Example, error)

	// List Knowledge Assistants
	//
	// This method is generated by Databricks SDK Code Generator.
	ListKnowledgeAssistants(ctx context.Context, request ListKnowledgeAssistantsRequest) listing.Iterator[KnowledgeAssistant]

	// List Knowledge Assistants
	//
	// This method is generated by Databricks SDK Code Generator.
	ListKnowledgeAssistantsAll(ctx context.Context, request ListKnowledgeAssistantsRequest) ([]KnowledgeAssistant, error)

	// Lists Knowledge Sources under a Knowledge Assistant.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListKnowledgeSources(ctx context.Context, request ListKnowledgeSourcesRequest) listing.Iterator[KnowledgeSource]

	// Lists Knowledge Sources under a Knowledge Assistant.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListKnowledgeSourcesAll(ctx context.Context, request ListKnowledgeSourcesRequest) ([]KnowledgeSource, error)

	// Sets permissions on an object, replacing existing permissions if they exist.
	// Deletes all direct permissions if none are specified. Objects can inherit
	// permissions from their root object.
	SetPermissions(ctx context.Context, request KnowledgeAssistantPermissionsRequest) (*KnowledgeAssistantPermissions, error)

	// Sync all non-index Knowledge Sources for a Knowledge Assistant (index sources
	// do not require sync)
	SyncKnowledgeSources(ctx context.Context, request SyncKnowledgeSourcesRequest) error

	// Updates an example in a Knowledge Assistant.
	UpdateExample(ctx context.Context, request UpdateExampleRequest) (*Example, error)

	// Updates a Knowledge Assistant.
	UpdateKnowledgeAssistant(ctx context.Context, request UpdateKnowledgeAssistantRequest) (*KnowledgeAssistant, error)

	// Updates a Knowledge Source.
	UpdateKnowledgeSource(ctx context.Context, request UpdateKnowledgeSourceRequest) (*KnowledgeSource, error)

	// Updates the permissions on a knowledge assistant. Knowledge assistants can
	// inherit permissions from their root object.
	UpdatePermissions(ctx context.Context, request KnowledgeAssistantPermissionsRequest) (*KnowledgeAssistantPermissions, error)
}

type KnowledgeSource struct {
	// Timestamp when this knowledge source was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// Description of the knowledge source. Required when creating a Knowledge
	// Source. When updating a Knowledge Source, optional unless included in
	// update_mask.
	Description string `json:"description"`
	// Human-readable display name of the knowledge source. Required when
	// creating a Knowledge Source. When updating a Knowledge Source, optional
	// unless included in update_mask.
	DisplayName string `json:"display_name"`

	FileTable *FileTableSpec `json:"file_table,omitempty"`

	Files *FilesSpec `json:"files,omitempty"`

	Id string `json:"id,omitempty"`

	Index *IndexSpec `json:"index,omitempty"`
	// Timestamp representing the cutoff before which content in this knowledge
	// source is being ingested.
	KnowledgeCutoffTime *time.Time `json:"knowledge_cutoff_time,omitempty"`
	// Full resource name:
	// knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
	Name string `json:"name,omitempty"`
	// The type of the source: "index", "files", or "file_table". Required when
	// creating a Knowledge Source. When updating a Knowledge Source, this field
	// is ignored.
	SourceType string `json:"source_type"`

	State KnowledgeSourceState `json:"state,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type KnowledgeSourceState string

type ListExamplesRequest struct {
	// 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 `json:"-" url:"page_size,omitempty"`
	// 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 `json:"-" url:"page_token,omitempty"`
	// Parent resource to list from. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Parent string `json:"-" url:"-"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListExamplesResponse struct {
	Examples []Example `json:"examples,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListKnowledgeAssistantsRequest struct {
	// The maximum number of knowledge assistants to return. If unspecified, at
	// most 100 knowledge assistants will be returned. The maximum value is 100;
	// values above 100 will be coerced to 100.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// A page token, received from a previous `ListKnowledgeAssistants` call.
	// Provide this to retrieve the subsequent page. If unspecified, the first
	// page will be returned.
	PageToken string `json:"-" url:"page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListKnowledgeAssistantsResponse struct {
	KnowledgeAssistants []KnowledgeAssistant `json:"knowledge_assistants,omitempty"`
	// 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 `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListKnowledgeSourcesRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`
	// Parent resource to list from. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Parent string `json:"-" url:"-"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListKnowledgeSourcesResponse struct {
	KnowledgeSources []KnowledgeSource `json:"knowledge_sources,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type SyncKnowledgeSourcesRequest struct {
	// The resource name of the Knowledge Assistant. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Name string `json:"-" url:"-"`
}

type UpdateExampleRequest struct {
	Example Example `json:"example"`
	// The resource name of the example to update. Format:
	// knowledge-assistants/{knowledge_assistant_id}/examples/{example_id}
	Name string `json:"-" url:"-"`
	// Comma-delimited list of fields to update on the example. Allowed values:
	// `question`, `guidelines`. Examples: - `question` - `question,guidelines`
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type UpdateKnowledgeAssistantRequest struct {
	// The Knowledge Assistant update payload. Only fields listed in update_mask
	// are updated. REQUIRED annotations on Knowledge Assistant fields describe
	// create-time requirements and do not mean all those fields are required
	// for update.
	KnowledgeAssistant KnowledgeAssistant `json:"knowledge_assistant"`
	// The resource name of the Knowledge Assistant. Format:
	// knowledge-assistants/{knowledge_assistant_id}
	Name string `json:"-" url:"-"`
	// Comma-delimited list of fields to update on the Knowledge Assistant.
	// Allowed values: `display_name`, `description`, `instructions`. Examples:
	// - `display_name` - `description,instructions`
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type UpdateKnowledgeSourceRequest struct {
	// The Knowledge Source update payload. Only fields listed in update_mask
	// are updated. REQUIRED annotations on Knowledge Source fields describe
	// create-time requirements and do not mean all those fields are required
	// for update.
	KnowledgeSource KnowledgeSource `json:"knowledge_source"`
	// The resource name of the Knowledge Source to update. Format:
	// knowledge-assistants/{knowledge_assistant_id}/knowledge-sources/{knowledge_source_id}
	Name string `json:"-" url:"-"`
	// Comma-delimited list of fields to update on the Knowledge Source. Allowed
	// values: `display_name`, `description`. Examples: - `display_name` -
	// `display_name,description`
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}