Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

apiclientgo

package module

Go to main page

Versions in this module

v0

v0.7.1

Jul 11, 2025

v0.7.0

Jul 7, 2025

v0.6.4

Jun 16, 2025

v0.6.3

Jun 9, 2025

v0.6.2

Jun 9, 2025

v0.6.1

Jun 6, 2025

v0.6.0

Jun 6, 2025

v0.5.1

Jun 5, 2025

v0.5.0

Jun 3, 2025

Changes in this version

type Glean

+ SDKVersion string

v0.4.4

May 24, 2025

v0.4.3

May 23, 2025

Changes in this version

type Client

+ Tools *Tools

+ type Tools struct

+ func (s *Tools) List(ctx context.Context, toolNames []string, opts ...operations.Option) (*operations.GetRestAPIV1ToolsListResponse, error)

+ func (s *Tools) Run(ctx context.Context, request components.ToolsCallRequest, ...) (*operations.PostRestAPIV1ToolsCallResponse, error)

v0.4.2

May 17, 2025

v0.4.1

May 16, 2025

v0.4.0

May 16, 2025

Changes in this version

+ var ServerList = []string

+ func Bool(b bool) *bool

+ func Float32(f float32) *float32

+ func Float64(f float64) *float64

+ func Int(i int) *int

+ func Int64(i int64) *int64

+ func Pointer[T any](v T) *T

+ func String(s string) *string

+ type Activity struct

+ func (s *Activity) Feedback(ctx context.Context, feedbackQueryParameter *string, ...) (*operations.FeedbackResponse, error)

+ func (s *Activity) Report(ctx context.Context, request components.Activity, opts ...operations.Option) (*operations.ActivityResponse, error)

+ type Agents struct

+ func (s *Agents) List(ctx context.Context, request components.SearchAgentsRequest, ...) (*operations.SearchAgentsResponse, error)

+ func (s *Agents) Retrieve(ctx context.Context, agentID string, timezoneOffset *int64, ...) (*operations.GetAgentResponse, error)

+ func (s *Agents) RetrieveSchemas(ctx context.Context, agentID string, timezoneOffset *int64, ...) (*operations.GetAgentSchemasResponse, error)

+ func (s *Agents) Run(ctx context.Context, request components.AgentRunCreate, ...) (*operations.CreateAndWaitRunResponse, error)

+ func (s *Agents) RunStream(ctx context.Context, request components.AgentRunCreate, ...) (*operations.CreateAndStreamRunResponse, error)

+ type Announcements struct

+ func (s *Announcements) Create(ctx context.Context, request components.CreateAnnouncementRequest, ...) (*operations.CreateannouncementResponse, error)

+ func (s *Announcements) Delete(ctx context.Context, request components.DeleteAnnouncementRequest, ...) (*operations.DeleteannouncementResponse, error)

+ func (s *Announcements) Update(ctx context.Context, request components.UpdateAnnouncementRequest, ...) (*operations.UpdateannouncementResponse, error)

+ type Answers struct

+ func (s *Answers) Create(ctx context.Context, request components.CreateAnswerRequest, ...) (*operations.CreateanswerResponse, error)

+ func (s *Answers) Delete(ctx context.Context, request components.DeleteAnswerRequest, ...) (*operations.DeleteanswerResponse, error)

+ func (s *Answers) List(ctx context.Context, request components.ListAnswersRequest, ...) (*operations.ListanswersResponse, error)

+ func (s *Answers) Retrieve(ctx context.Context, request components.GetAnswerRequest, ...) (*operations.GetanswerResponse, error)

+ func (s *Answers) Update(ctx context.Context, request components.EditAnswerRequest, ...) (*operations.EditanswerResponse, error)

+ type Chat struct

+ func (s *Chat) Create(ctx context.Context, chatRequest components.ChatRequest, timezoneOffset *int64, ...) (*operations.ChatResponse, error)

+ func (s *Chat) CreateStream(ctx context.Context, chatRequest components.ChatRequest, timezoneOffset *int64, ...) (*operations.ChatStreamResponse, error)

+ func (s *Chat) Delete(ctx context.Context, deleteChatsRequest components.DeleteChatsRequest, ...) (*operations.DeletechatsResponse, error)

+ func (s *Chat) DeleteAll(ctx context.Context, timezoneOffset *int64, opts ...operations.Option) (*operations.DeleteallchatsResponse, error)

+ func (s *Chat) DeleteFiles(ctx context.Context, deleteChatFilesRequest components.DeleteChatFilesRequest, ...) (*operations.DeletechatfilesResponse, error)

+ func (s *Chat) List(ctx context.Context, timezoneOffset *int64, opts ...operations.Option) (*operations.ListchatsResponse, error)

+ func (s *Chat) Retrieve(ctx context.Context, getChatRequest components.GetChatRequest, ...) (*operations.GetchatResponse, error)

+ func (s *Chat) RetrieveApplication(ctx context.Context, ...) (*operations.GetchatapplicationResponse, error)

+ func (s *Chat) RetrieveFiles(ctx context.Context, getChatFilesRequest components.GetChatFilesRequest, ...) (*operations.GetchatfilesResponse, error)

+ func (s *Chat) UploadFiles(ctx context.Context, uploadChatFilesRequest components.UploadChatFilesRequest, ...) (*operations.UploadchatfilesResponse, error)

+ type Client struct

+ Activity *Activity

+ Agents *Agents

+ Announcements *Announcements

+ Answers *Answers

+ Authentication *ClientAuthentication

+ Chat *Chat

+ Collections *Collections

+ Documents *ClientDocuments

+ Entities *Entities

+ Governance *Governance

+ Insights *Insights

+ Messages *Messages

+ Pins *Pins

+ Search *Search

+ Shortcuts *ClientShortcuts

+ Verification *Verification

+ type ClientAuthentication struct

+ func (s *ClientAuthentication) CreateToken(ctx context.Context, opts ...operations.Option) (*operations.CreateauthtokenResponse, error)

+ type ClientDocuments struct

+ func (s *ClientDocuments) Retrieve(ctx context.Context, request *components.GetDocumentsRequest, ...) (*operations.GetdocumentsResponse, error)

+ func (s *ClientDocuments) RetrieveByFacets(ctx context.Context, request *components.GetDocumentsByFacetsRequest, ...) (*operations.GetdocumentsbyfacetsResponse, error)

+ func (s *ClientDocuments) RetrievePermissions(ctx context.Context, request components.GetDocPermissionsRequest, ...) (*operations.GetdocpermissionsResponse, error)

+ func (s *ClientDocuments) Summarize(ctx context.Context, request components.SummarizeRequest, ...) (*operations.SummarizeResponse, error)

+ type ClientShortcuts struct

+ func (s *ClientShortcuts) Create(ctx context.Context, request components.CreateShortcutRequest, ...) (*operations.CreateshortcutResponse, error)

+ func (s *ClientShortcuts) Delete(ctx context.Context, request components.DeleteShortcutRequest, ...) (*operations.DeleteshortcutResponse, error)

+ func (s *ClientShortcuts) List(ctx context.Context, request components.ListShortcutsPaginatedRequest, ...) (*operations.ListshortcutsResponse, error)

+ func (s *ClientShortcuts) Retrieve(ctx context.Context, request components.GetShortcutRequestUnion, ...) (*operations.GetshortcutResponse, error)

+ func (s *ClientShortcuts) Update(ctx context.Context, request components.UpdateShortcutRequest, ...) (*operations.UpdateshortcutResponse, error)

+ type Collections struct

+ func (s *Collections) AddItems(ctx context.Context, request components.AddCollectionItemsRequest, ...) (*operations.AddcollectionitemsResponse, error)

+ func (s *Collections) Create(ctx context.Context, request components.CreateCollectionRequest, ...) (*operations.CreatecollectionResponse, error)

+ func (s *Collections) Delete(ctx context.Context, request components.DeleteCollectionRequest, ...) (*operations.DeletecollectionResponse, error)

+ func (s *Collections) DeleteItem(ctx context.Context, request components.DeleteCollectionItemRequest, ...) (*operations.DeletecollectionitemResponse, error)

+ func (s *Collections) List(ctx context.Context, request components.ListCollectionsRequest, ...) (*operations.ListcollectionsResponse, error)

+ func (s *Collections) Retrieve(ctx context.Context, request components.GetCollectionRequest, ...) (*operations.GetcollectionResponse, error)

+ func (s *Collections) Update(ctx context.Context, request components.EditCollectionRequest, ...) (*operations.EditcollectionResponse, error)

+ func (s *Collections) UpdateItem(ctx context.Context, request components.EditCollectionItemRequest, ...) (*operations.EditcollectionitemResponse, error)

+ type Data struct

+ Policies *Policies

+ Reports *Reports

+ type Datasource struct

+ func (s *Datasource) Status(ctx context.Context, datasource string, opts ...operations.Option) (*operations.PostAPIIndexV1DebugDatasourceStatusResponse, error)

+ type Datasources struct

+ func (s *Datasources) Add(ctx context.Context, request components.CustomDatasourceConfig, ...) (*operations.PostAPIIndexV1AdddatasourceResponse, error)

+ func (s *Datasources) RetrieveConfig(ctx context.Context, request components.GetDatasourceConfigRequest, ...) (*operations.PostAPIIndexV1GetdatasourceconfigResponse, error)

+ type Entities struct

+ func (s *Entities) List(ctx context.Context, request components.ListEntitiesRequest, ...) (*operations.ListentitiesResponse, error)

+ func (s *Entities) ReadPeople(ctx context.Context, request components.PeopleRequest, ...) (*operations.PeopleResponse, error)

+ type Glean struct

+ Client *Client

+ Indexing *Indexing

+ func New(opts ...SDKOption) *Glean

+ type Governance struct

+ Data *Data

+ Documents *GovernanceDocuments

+ type GovernanceDocuments struct

+ Visibilityoverrides *Visibilityoverrides

+ type HTTPClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type Indexing struct

+ Authentication *IndexingAuthentication

+ Datasource *Datasource

+ Datasources *Datasources

+ Documents *IndexingDocuments

+ People *People

+ Permissions *Permissions

+ Shortcuts *IndexingShortcuts

+ type IndexingAuthentication struct

+ func (s *IndexingAuthentication) RotateToken(ctx context.Context, opts ...operations.Option) (*operations.PostAPIIndexV1RotatetokenResponse, error)

+ type IndexingDocuments struct

+ func (s *IndexingDocuments) AddOrUpdate(ctx context.Context, request components.IndexDocumentRequest, ...) (*operations.PostAPIIndexV1IndexdocumentResponse, error)

+ func (s *IndexingDocuments) BulkIndex(ctx context.Context, request components.BulkIndexDocumentsRequest, ...) (*operations.PostAPIIndexV1BulkindexdocumentsResponse, error)

+ func (s *IndexingDocuments) CheckAccess(ctx context.Context, request components.CheckDocumentAccessRequest, ...) (*operations.PostAPIIndexV1CheckdocumentaccessResponse, error)

+ func (s *IndexingDocuments) Count(ctx context.Context, request components.GetDocumentCountRequest, ...) (*operations.PostAPIIndexV1GetdocumentcountResponse, error)

+ func (s *IndexingDocuments) Debug(ctx context.Context, datasource string, ...) (*operations.PostAPIIndexV1DebugDatasourceDocumentResponse, error)

+ func (s *IndexingDocuments) DebugMany(ctx context.Context, datasource string, ...) (*operations.PostAPIIndexV1DebugDatasourceDocumentsResponse, error)

+ func (s *IndexingDocuments) Delete(ctx context.Context, request components.DeleteDocumentRequest, ...) (*operations.PostAPIIndexV1DeletedocumentResponse, error)

+ func (s *IndexingDocuments) Index(ctx context.Context, request components.IndexDocumentsRequest, ...) (*operations.PostAPIIndexV1IndexdocumentsResponse, error)

+ func (s *IndexingDocuments) ProcessAll(ctx context.Context, request *components.ProcessAllDocumentsRequest, ...) (*operations.PostAPIIndexV1ProcessalldocumentsResponse, error)

+ func (s *IndexingDocuments) Status(ctx context.Context, request components.GetDocumentStatusRequest, ...) (*operations.PostAPIIndexV1GetdocumentstatusResponse, error)

+ type IndexingShortcuts struct

+ func (s *IndexingShortcuts) BulkIndex(ctx context.Context, request components.BulkIndexShortcutsRequest, ...) (*operations.PostAPIIndexV1BulkindexshortcutsResponse, error)

+ func (s *IndexingShortcuts) Upload(ctx context.Context, request components.UploadShortcutsRequest, ...) (*operations.PostAPIIndexV1UploadshortcutsResponse, error)

+ type Insights struct

+ func (s *Insights) Retrieve(ctx context.Context, request components.InsightsRequest, ...) (*operations.InsightsResponse, error)

+ type Messages struct

+ func (s *Messages) Retrieve(ctx context.Context, request components.MessagesRequest, ...) (*operations.MessagesResponse, error)

+ type People struct

+ func (s *People) BulkIndex(ctx context.Context, request components.BulkIndexEmployeesRequest, ...) (*operations.PostAPIIndexV1BulkindexemployeesResponse, error)

+ func (s *People) BulkIndexTeams(ctx context.Context, request components.BulkIndexTeamsRequest, ...) (*operations.PostAPIIndexV1BulkindexteamsResponse, error)

+ func (s *People) Count(ctx context.Context, request components.GetUserCountRequest, ...) (*operations.PostAPIIndexV1GetusercountResponse, error)

+ func (s *People) Debug(ctx context.Context, datasource string, ...) (*operations.PostAPIIndexV1DebugDatasourceUserResponse, error)

+ func (s *People) Delete(ctx context.Context, request components.DeleteEmployeeRequest, ...) (*operations.PostAPIIndexV1DeleteemployeeResponse, error)

+ func (s *People) DeleteTeam(ctx context.Context, request components.DeleteTeamRequest, ...) (*operations.PostAPIIndexV1DeleteteamResponse, error)

+ func (s *People) Index(ctx context.Context, request components.IndexEmployeeRequest, ...) (*operations.PostAPIIndexV1IndexemployeeResponse, error)

+ func (s *People) IndexTeam(ctx context.Context, request components.IndexTeamRequest, ...) (*operations.PostAPIIndexV1IndexteamResponse, error)

+ func (s *People) ProcessAllEmployeesAndTeams(ctx context.Context, opts ...operations.Option) (*operations.PostAPIIndexV1ProcessallemployeesandteamsResponse, error)

+ type Permissions struct

+ func (s *Permissions) AuthorizeBetaUsers(ctx context.Context, request components.GreenlistUsersRequest, ...) (*operations.PostAPIIndexV1BetausersResponse, error)

+ func (s *Permissions) BulkIndexGroups(ctx context.Context, request components.BulkIndexGroupsRequest, ...) (*operations.PostAPIIndexV1BulkindexgroupsResponse, error)

+ func (s *Permissions) BulkIndexMemberships(ctx context.Context, request components.BulkIndexMembershipsRequest, ...) (*operations.PostAPIIndexV1BulkindexmembershipsResponse, error)

+ func (s *Permissions) BulkIndexUsers(ctx context.Context, request components.BulkIndexUsersRequest, ...) (*operations.PostAPIIndexV1BulkindexusersResponse, error)

+ func (s *Permissions) DeleteGroup(ctx context.Context, request components.DeleteGroupRequest, ...) (*operations.PostAPIIndexV1DeletegroupResponse, error)

+ func (s *Permissions) DeleteMembership(ctx context.Context, request components.DeleteMembershipRequest, ...) (*operations.PostAPIIndexV1DeletemembershipResponse, error)

+ func (s *Permissions) DeleteUser(ctx context.Context, request components.DeleteUserRequest, ...) (*operations.PostAPIIndexV1DeleteuserResponse, error)

+ func (s *Permissions) IndexGroup(ctx context.Context, request components.IndexGroupRequest, ...) (*operations.PostAPIIndexV1IndexgroupResponse, error)

+ func (s *Permissions) IndexMembership(ctx context.Context, request components.IndexMembershipRequest, ...) (*operations.PostAPIIndexV1IndexmembershipResponse, error)

+ func (s *Permissions) IndexUser(ctx context.Context, request components.IndexUserRequest, ...) (*operations.PostAPIIndexV1IndexuserResponse, error)

+ func (s *Permissions) ProcessMemberships(ctx context.Context, request *components.ProcessAllMembershipsRequest, ...) (*operations.PostAPIIndexV1ProcessallmembershipsResponse, error)

+ func (s *Permissions) UpdatePermissions(ctx context.Context, request components.UpdatePermissionsRequest, ...) (*operations.PostAPIIndexV1UpdatepermissionsResponse, error)

+ type Pins struct

+ func (s *Pins) Create(ctx context.Context, request components.PinRequest, opts ...operations.Option) (*operations.PinResponse, error)

+ func (s *Pins) List(ctx context.Context, request operations.ListpinsRequest, ...) (*operations.ListpinsResponse, error)

+ func (s *Pins) Remove(ctx context.Context, request components.Unpin, opts ...operations.Option) (*operations.UnpinResponse, error)

+ func (s *Pins) Retrieve(ctx context.Context, request components.GetPinRequest, ...) (*operations.GetpinResponse, error)

+ func (s *Pins) Update(ctx context.Context, request components.EditPinRequest, ...) (*operations.EditpinResponse, error)

+ type Policies struct

+ func (s *Policies) Create(ctx context.Context, request components.CreateDlpReportRequest, ...) (*operations.CreatepolicyResponse, error)

+ func (s *Policies) Download(ctx context.Context, id string, opts ...operations.Option) (*operations.DownloadpolicycsvResponse, error)

+ func (s *Policies) List(ctx context.Context, autoHide *bool, frequency *string, ...) (*operations.GetpoliciesResponse, error)

+ func (s *Policies) Retrieve(ctx context.Context, id string, version *int64, opts ...operations.Option) (*operations.GetpolicyResponse, error)

+ func (s *Policies) Update(ctx context.Context, id string, ...) (*operations.UpdatepolicyResponse, error)

+ type Reports struct

+ func (s *Reports) Create(ctx context.Context, request components.UpdateDlpConfigRequest, ...) (*operations.CreatereportResponse, error)

+ func (s *Reports) Download(ctx context.Context, id string, opts ...operations.Option) (*operations.DownloadreportcsvResponse, error)

+ func (s *Reports) Status(ctx context.Context, id string, opts ...operations.Option) (*operations.GetreportstatusResponse, error)

+ type SDKOption func(*Glean)

+ func WithClient(client HTTPClient) SDKOption

+ func WithInstance(instance string) SDKOption

+ func WithRetryConfig(retryConfig retry.Config) SDKOption

+ func WithSecurity(security components.Security) SDKOption

+ func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption

+ func WithServerIndex(serverIndex int) SDKOption

+ func WithServerURL(serverURL string) SDKOption

+ func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption

+ func WithTimeout(timeout time.Duration) SDKOption

+ type Search struct

+ func (s *Search) Autocomplete(ctx context.Context, request components.AutocompleteRequest, ...) (*operations.AutocompleteResponse, error)

+ func (s *Search) Query(ctx context.Context, request *components.SearchRequest, ...) (*operations.SearchResponse, error)

+ func (s *Search) QueryAsAdmin(ctx context.Context, request *components.SearchRequest, ...) (*operations.AdminsearchResponse, error)

+ func (s *Search) Recommendations(ctx context.Context, request *components.RecommendationsRequest, ...) (*operations.RecommendationsResponse, error)

+ func (s *Search) RetrieveFeed(ctx context.Context, request components.FeedRequest, opts ...operations.Option) (*operations.FeedResponse, error)

+ type Verification struct

+ func (s *Verification) AddReminder(ctx context.Context, request components.ReminderRequest, ...) (*operations.AddverificationreminderResponse, error)

+ func (s *Verification) List(ctx context.Context, count *int64, opts ...operations.Option) (*operations.ListverificationsResponse, error)

+ func (s *Verification) Verify(ctx context.Context, request components.VerifyRequest, ...) (*operations.VerifyResponse, error)

+ type Visibilityoverrides struct

+ func (s *Visibilityoverrides) Create(ctx context.Context, ...) (*operations.SetdocvisibilityResponse, error)

+ func (s *Visibilityoverrides) List(ctx context.Context, docIds []string, opts ...operations.Option) (*operations.GetdocvisibilityResponse, error)

v0.3.0

May 9, 2025

v0.2.0

May 6, 2025

v0.1.0-beta.2

May 6, 2025

v0.1.0-beta.1

Apr 30, 2025