content large_stringlengths 3 20.5k | url large_stringlengths 53 192 ⌀ | branch large_stringclasses 4
values | source large_stringclasses 51
values | embeddings listlengths 384 384 | score float64 -0.21 0.65 |
|---|---|---|---|---|---|
that such communication be in writing. You hereby agree to the use of electronic signatures, contracts, orders and other records and to electronic delivery of notices, policies and records of transactions initiated or completed by us or via the Site. You hereby waive any rights or requirements under any statutes, regul... | https://github.com/spacelift-io/user-documentation/blob/main/docs/legal/archive/terms.md | main | spacelift | [
-0.07432449609041214,
0.05173170194029808,
-0.01888243295252323,
-0.11020106077194214,
-0.02356584370136261,
0.009334931150078773,
0.04417506232857704,
-0.05953426659107208,
-0.010026892647147179,
-0.059027403593063354,
0.03858209401369095,
0.007370124105364084,
0.03229233995079994,
-0.022... | 0.115795 |
# Search GitLab Docs supports two search backends: [Elasticsearch](https://www.elastic.co/elasticsearch) and [Pagefind](https://pagefind.app/). The primary production site, `docs.gitlab.com`, runs Elasticsearch. Archives and self-hosted sites run Pagefind. Environment variables are passed at build time to set the searc... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/search.md | main | gitlab | [
-0.05706504359841347,
-0.01089656725525856,
0.002311868127435446,
0.030228741466999054,
-0.030113233253359795,
-0.05574730783700943,
-0.09382011741399765,
-0.04222660884261131,
0.053408343344926834,
0.06273161619901657,
-0.019794611260294914,
0.022658515721559525,
0.12998664379119873,
-0.0... | 0.041304 |
- Revert recent changes to search functionality - Note that the cluster may take additional time to recover after MR revert and deployment 2. \*\*If problems persist:\*\* - Consider increasing Elastic server capacity (but be careful, increasing the wrong resources can worsen bottlenecks) - Contact [Elastic support](htt... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/search.md | main | gitlab | [
0.0012592730345204473,
-0.010317199863493443,
0.043606068938970566,
0.08221473544836044,
0.032892342656850815,
-0.044769372791051865,
-0.06590594351291656,
-0.0313967727124691,
-0.0636727586388588,
0.047879721969366074,
-0.004350343253463507,
0.043948668986558914,
0.008537480607628822,
0.0... | 0.091692 |
run Pagefind locally. - To run the site with Elasticsearch use `make view`. - To run the site with Pagefind search, run an archive build: `make view-archive`. See [Develop for Archived Versions Locally](versions.md#develop-for-archived-versions-locally). for more information. #### Local build with Elasticsearch Queryin... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/search.md | main | gitlab | [
-0.018220307305455208,
0.023310646414756775,
-0.027841487899422646,
0.04027430713176727,
-0.00294026848860085,
-0.06036478653550148,
-0.10440126061439514,
-0.017675532028079033,
-0.005602521356195211,
0.071561798453331,
-0.0045576454140245914,
0.026902616024017334,
0.11157788336277008,
0.0... | -0.069942 |
# Docs site architecture While the source of the documentation content is stored in the repositories for each GitLab product, the source that is used to build the documentation site \_from that content\_ is located at . The following diagram illustrates the relationship between the repositories from where content is so... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/architecture.md | main | gitlab | [
-0.08466736227273941,
0.0029540620744228363,
0.03532851114869118,
-0.019143514335155487,
0.023829258978366852,
-0.07847185432910919,
-0.030407967045903206,
0.007244419306516647,
0.08279306441545486,
-0.005401459522545338,
0.025458648800849915,
0.004018343985080719,
0.11882095783948898,
0.0... | 0.040378 |
type. For example: ```yaml workflow: name: '$DOCS\_PROJECT\_PIPELINE\_TYPE' rules: - if: '$CI\_PIPELINE\_SOURCE == "merge\_request\_event"' variables: DOCS\_PROJECT\_PIPELINE\_TYPE: "MR pipeline: branch $CI\_MERGE\_REQUEST\_SOURCE\_BRANCH\_NAME" SEARCH\_BACKEND: 'elastic' - if: '$CI\_PIPELINE\_SOURCE == "schedule" && $... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/architecture.md | main | gitlab | [
-0.011664213612675667,
0.026019040495157242,
0.03272939845919609,
0.010779040865600109,
-0.0583551786839962,
-0.08604872971773148,
0.019263816997408867,
-0.04651075601577759,
0.03732233867049217,
-0.0000018823794789568637,
-0.032635293900966644,
-0.035500798374414444,
0.03378605470061302,
... | -0.000033 |
and `navigation.yaml` configuration files. For example, `/data/ja-jp/` for Japanese translations. `en-us/` contains the canonical sources. - `/i18n/`: Stores YAML files with UI element translations and short strings for each supported language. `en-us.yaml` is the canonical source. - `/locales/`: Stores JSON files with... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/architecture.md | main | gitlab | [
-0.009420689195394516,
-0.026662657037377357,
-0.02711988426744938,
-0.048700280487537384,
0.0714239850640297,
-0.011259824968874454,
-0.008144988678395748,
0.039041854441165924,
0.013711604289710522,
-0.00588495098054409,
0.04767339304089546,
0.04697975143790245,
0.005069597624242306,
-0.... | 0.167379 |
# Monthly documentation releases When a new GitLab version is released on the third Thursday of the month, we release version-specific published documentation for the new version. The tasks described in this document cover the preparation steps and the publication steps. The preparation steps are completed on your loca... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/releases.md | main | gitlab | [
-0.025849327445030212,
0.0036854727659374475,
0.06458805501461029,
-0.012535746209323406,
0.002176122274249792,
-0.09449425339698792,
-0.08415006846189499,
-0.01836690865457058,
0.03482033684849739,
0.05821794643998146,
0.026697898283600807,
0.05935893952846527,
0.05509879067540169,
-0.012... | -0.040353 |
. --build-arg CI\_COMMIT\_REF\_NAME=18.7 --build-arg HUGO\_VERSION= --build-arg COREPACK\_VERSION= docker run -it --rm -p 4000:4000 docs:18.7 ``` The appropriate values for `HUGO\_VERSION` and `COREPACK\_VERSION` are defined in [`.gitlab-ci.yml`](../.gitlab-ci.yml). If you get a permission error, try running the comman... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/releases.md | main | gitlab | [
-0.027956994250416756,
0.036350738257169724,
0.024846114218235016,
-0.05496406927704811,
0.026254156604409218,
-0.11071018874645233,
-0.04094235226511955,
0.030170438811182976,
-0.012927483767271042,
0.003338727168738842,
0.005293858703225851,
-0.08261077105998993,
0.046337809413671494,
-0... | -0.048422 |
# LLMS.TXT An `llms.txt` file is generated in the CI/CD pipeline for every build. This ensures the file is always available, even if the navigation hasn't changed. Generating the `llms.txt` takes ~600 ms. - \*\*File location:\*\* `public/llms.txt` - \*\*Deployed location:\*\* `https://docs.gitlab.com/llms.txt` To manua... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/llms-txt.md | main | gitlab | [
0.020701175555586815,
-0.004777675494551659,
-0.0001018866096273996,
-0.031102379783988,
0.03676228225231171,
-0.12131080776453018,
-0.06992218643426895,
0.06379466503858566,
0.03007957525551319,
0.05308229476213455,
-0.005330593325197697,
-0.002236256143078208,
0.07064466178417206,
-0.077... | 0.010686 |
# Experimental features Features that aren't ready for broad usage yet. ## Walkthroughs The walkthrough component guides users through a series of questions to provide them with a personalized recommendation based on their inputs. A walkthrough consists of: - Structured content, sourced from a YAML file - A Hugo shortc... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/experiments.md | main | gitlab | [
-0.07484924793243408,
-0.011653361842036247,
0.03940090537071228,
0.07233336567878723,
0.08805518597364426,
0.040457431226968765,
-0.08660738170146942,
0.06851677596569061,
-0.058129701763391495,
-0.0066895135678350925,
-0.026795389130711555,
0.010245594196021557,
-0.06376173347234726,
0.0... | 0.07539 |
# Troubleshooting The [`#docs-site-changes-hugo`](https://gitlab.slack.com/archives/C084Z4DQR7V) Slack channel gets notifications: - When new MRs are opened, approved, and merged into `main`. - For all failed pipelines in `main`. Failed jobs are retried two more times if they fail (they run three times in total). Befor... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/troubleshooting.md | main | gitlab | [
-0.06677448749542236,
-0.04762033000588417,
0.051081471145153046,
-0.008991883136332035,
0.01569424383342266,
-0.13353994488716125,
-0.06312242895364761,
-0.006810302846133709,
-0.030668819323182106,
0.021700816228985786,
-0.036343567073345184,
-0.01676878146827221,
0.043147675693035126,
0... | -0.045532 |
# Release posts > [!warning] > The monthly release posts now live in the `gitlab` repo. > Do not use the `build\_release\_posts` command to update a monthly post. > The command can still be used for creating and updating patch release posts, and will be used to generate 19.0. ## Monthly release posts Monthly release po... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/release-posts.md | main | gitlab | [
-0.06576831638813019,
0.0036862085107713938,
0.020449336618185043,
0.0015776060754433274,
0.02764718048274517,
-0.04606219381093979,
-0.07497572153806686,
0.006010378710925579,
0.020971769466996193,
0.07046335190534592,
0.06319767236709595,
0.06878165155649185,
0.0724680945277214,
-0.08075... | 0.074163 |
# Set up local development and preview Set up your workstation to preview content changes on the GitLab Docs website. If you intend to do development work on the site, see [GitLab docs site development](development.md) for additional setup guidelines. ## Prerequisites Prerequisites: - [Git](https://git-scm.com) - Make.... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/setup.md | main | gitlab | [
-0.03570551052689552,
-0.060402922332286835,
0.039594125002622604,
-0.04080021381378174,
-0.02482459880411625,
-0.08649628609418869,
-0.04170642048120499,
0.033549778163433075,
-0.026378925889730453,
-0.008790794759988785,
-0.005649668164551258,
-0.031917721033096313,
0.037649545818567276,
... | 0.026233 |
you get an error about a missing tool or dependency when you run `make setup`, check that `mise` is installed and that it is [activated](https://mise.jdx.dev/getting-started.html#activate-mise) correctly in your shell's configuration. If you update your shell configuration file, such as `~/.zshrc`, make sure you close ... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/setup.md | main | gitlab | [
-0.07100991159677505,
-0.0673457607626915,
0.01437037717550993,
-0.037695903331041336,
-0.04628581926226616,
-0.1307629942893982,
0.010289676487445831,
-0.0007079644128680229,
-0.005684674717485905,
-0.0021269703283905983,
0.03355764225125313,
-0.03419935703277588,
0.10086435079574585,
0.0... | -0.06723 |
# Redirects The Docs website uses three different kinds of redirects to ensure that outdated links continue to work for visitors. Maintaining old links is important because many customers run older versions of the GitLab product, which has older links to the Docs site from the UI. The move to Hugo complicates redirect ... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/redirects.md | main | gitlab | [
-0.08016595244407654,
-0.06086302176117897,
0.0888151004910469,
-0.0021549221128225327,
0.07836795598268509,
-0.11300412565469742,
-0.06712496280670166,
0.012870333157479763,
0.04668080061674118,
0.018471429124474525,
-0.01639448292553425,
0.10309580713510513,
0.0270898025482893,
-0.039832... | 0.03706 |
# Dependency management The GitLab Docs website project depends on many third-party software packages. Dependency management is an ongoing maintenance task that is managed by engineers on the Technical Writing team. ## Guidelines for all updates - Understand what the dependency is used for. What does it do on the site?... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/dependencies.md | main | gitlab | [
-0.09539366513490677,
-0.03120657056570053,
0.07399635761976242,
-0.005369965918362141,
-0.0043660239316523075,
-0.12462969124317169,
-0.020448533818125725,
-0.044372737407684326,
-0.03160153701901436,
0.05260520428419113,
0.018941795453429222,
0.05409331992268562,
0.05177059769630432,
0.0... | 0.055678 |
the previous step (for example, for `3.22.1`, select `v3.22`). Then select \*\*Search\*\*. ## Manually managed DocOps dependencies The [DocOps group](https://handbook.gitlab.com/handbook/product/ux/technical-writing/#docops-group) manages updates for the following documentation tools: - Lychee (). - `markdownlint-cli2`... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/dependencies.md | main | gitlab | [
-0.06837058812379837,
0.07992468774318695,
0.06402451545000076,
0.006970327813178301,
0.03446781262755394,
-0.06299909204244614,
-0.035456642508506775,
0.005138508975505829,
0.052414678037166595,
0.023481426760554314,
-0.04123646020889282,
0.0025726931635290384,
0.06730856746435165,
0.0089... | 0.031083 |
# Docs site analytics The Technical Writing team tracks website usage with Google Analytics. GitLab team members can browse Google Analytics data on the [Google Analytics dashboard](https://lookerstudio.google.com/reporting/d6af7a2b-2aaa-4f30-8742-811e62777c93/page/p\_ihbvblyl2c). This dashboard includes data from [Ela... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/analytics.md | main | gitlab | [
-0.07967427372932434,
-0.008376020938158035,
-0.10679615288972855,
0.08093000203371048,
0.021264346316456795,
-0.0813760906457901,
0.05407604202628136,
-0.016622304916381836,
-0.006291278637945652,
0.022465039044618607,
0.015910077840089798,
0.03839723765850067,
0.11845101416110992,
0.0006... | 0.084069 |
# Version-aware features A new release of the Docs website is cut with each release of the GitLab product. Most of the site behaves the same way regardless of version, however there are a few features that are version-aware: - Archived version banner - Versions dropdown - Survey banner - Search - robots.txt - Localized... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/versions.md | main | gitlab | [
-0.031156295910477638,
0.04898602142930031,
0.07279770821332932,
0.0011316841701045632,
0.08652112632989883,
-0.05683087930083275,
-0.06688225269317627,
-0.09385869652032852,
0.042172871530056,
0.04911234974861145,
0.02830752730369568,
0.07027263939380646,
0.023311931639909744,
0.010492393... | 0.040954 |
updated beyond that. - \*\*Frontend:\*\* Frontend features can fetch up-to-date version context from the `versions.json` file at `docs.gitlab.com/versions.json`. While this can be used to determine an instance's status (pre-release, stable, etc.), remember that this (or any other `fetch` request) cannot be used in an o... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/versions.md | main | gitlab | [
-0.037382885813713074,
0.006836272310465574,
0.03583196923136711,
0.0043558599427342415,
0.03208335116505623,
-0.08579497039318085,
-0.0473041832447052,
-0.028081879019737244,
-0.020460259169340134,
0.010226266458630562,
0.004485588986426592,
0.07193951308727264,
-0.00030729995341971517,
-... | -0.016076 |
# Testing the GitLab Docs site Tests for the GitLab Docs site include tests for code and tests for links in content. For more information, see [Documentation testing](https://docs.gitlab.com/development/documentation/testing/). Tests are run in `docs-gitlab-com` [CI/CD pipeline](https://gitlab.com/gitlab-org/technical-... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/testing.md | main | gitlab | [
-0.07001709938049316,
-0.01738649792969227,
0.016271544620394707,
0.04218105599284172,
-0.007195430342108011,
-0.11981859058141708,
-0.046411190181970596,
-0.040772076696157455,
-0.020433660596609116,
-0.01802755519747734,
0.047562386840581894,
-0.03553163632750511,
0.10598008334636688,
-0... | 0.004894 |
# Monthly tasks Every month the technical writing team runs some tasks to help maintain the overall quality of the documentation site. You can run these tools locally, and sometimes as part of the [Monthly tasks (manual)](https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/pipeline\_schedules). scheduled ... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/tasks.md | main | gitlab | [
-0.10312465578317642,
0.038604483008384705,
0.039128415286540985,
0.05146263167262077,
0.009726911783218384,
-0.1544143706560135,
-0.057851824909448624,
-0.04372277110815048,
0.06705416738986969,
0.05000166967511177,
0.006004403345286846,
0.08682188391685486,
0.13192296028137207,
0.0567728... | 0.042608 |
# GitLab Docs site The GitLab Docs site contains documentation from the following projects: - [GitLab](https://gitlab.com/gitlab-org/gitlab) - [Omnibus GitLab](https://gitlab.com/gitlab-org/omnibus-gitlab) - [GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) - [GitLab Helm chart](https://gitlab.com/gitlab-org... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/index.md | main | gitlab | [
-0.08725709468126297,
0.0030215498991310596,
0.04220179468393326,
-0.013444998301565647,
-0.02957727015018463,
-0.10352075845003128,
-0.05969800800085068,
-0.017791057005524635,
0.03987300395965576,
0.007864771410822868,
0.019143925979733467,
-0.026749802753329277,
0.0818965956568718,
-0.0... | 0.029841 |
# Banners Several banners appear on the Documentation site under different conditions and with different requirements. All of the banners are rendered by the [`doc\_banners` component](../themes/gitlab-docs/src/components/docs\_banner.vue). ## Archive banner The archive banner appears only on interior pages of archived... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/banners.md | main | gitlab | [
-0.05437473580241203,
0.15419639647006989,
0.008031656965613365,
0.04530021548271179,
0.104204922914505,
-0.05448858067393303,
-0.06902426481246948,
-0.04990522935986519,
0.036053020507097244,
0.01388595998287201,
-0.008544659242033958,
0.011189905926585197,
0.010505360551178455,
0.0280169... | 0.031163 |
# GitLab docs site development Before starting development, follow the [Setup guide](setup.md) to clone the project and install dependencies. ## Build process The Docs website uses [Hugo](https://gohugo.io/) to transform Markdown files to HTML webpages. Additional build steps clone the source content, build complex con... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/development.md | main | gitlab | [
-0.06007843464612961,
0.030907467007637024,
-0.0007603316335007548,
0.04237184301018715,
-0.0013351362431421876,
-0.0887482613325119,
-0.10488460212945938,
0.015857785940170288,
-0.006236447487026453,
0.041027817875146866,
-0.023207342252135277,
0.0401114895939827,
0.08930865675210953,
-0.... | -0.010866 |
use [utility classes](https://docs.gitlab.com/development/fe\_guide/style/scss/#utility-classes) where possible. Custom CSS files live in two places: - Files process by Vite live in src/css. These styles meant to be bundled, minified, processed through PostCSS/Tailwind, and loaded as a single sheet per layout. - Styles... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/development.md | main | gitlab | [
-0.07551898807287216,
0.07574570178985596,
-0.051512476056814194,
0.003045329125598073,
0.04248078539967537,
-0.021145407110452652,
0.01758750155568123,
0.06314162164926529,
-0.03134671226143837,
-0.03201252594590187,
-0.04217619076371193,
0.03379188850522041,
0.058078259229660034,
-0.0284... | 0.015748 |
see [Use `logger` instead of `log` to print logs](#use-logger-instead-of-log-to-print-logs). ### Add to Makefiles To add debug output to Makefiles, use one of these: - `@printf "$(INFO\_COLOR\_SET)INFO$(COLOR\_RESET) \n"` to indicate general information or success, and provide a message. - `@printf "$(WARN\_COLOR\_SET)... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/development.md | main | gitlab | [
0.0025928691029548645,
-0.023068884387612343,
0.003783242544159293,
0.06266581267118454,
0.1180441603064537,
-0.010597402229905128,
0.07212567329406738,
-0.00514796981588006,
0.03339090943336487,
0.022376133129000664,
0.02144164778292179,
-0.028258899226784706,
0.07173996418714523,
-0.0898... | -0.030186 |
the merge request is ready for merge, remove the separate commit that added the environment variables to the CI/CD pipeline configuration. Make sure a new pipeline runs and passes before merge. ### Specify search backend Elasticsearch is the default search backend for review apps. To set `Pagefind` as the search backen... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/development.md | main | gitlab | [
-0.007399945519864559,
0.037682343274354935,
0.03770953044295311,
-0.008114741183817387,
-0.039516668766736984,
-0.06295625865459442,
-0.08362146466970444,
0.007675183471292257,
0.010660500265657902,
0.08944709599018097,
-0.027381539344787598,
-0.008195209316909313,
0.08193880319595337,
0.... | -0.094375 |
# Docs site infrastructure Use this guide to determine what to do in the event of infrastructure problems with the GitLab Docs website. Infrastructure issues will likely require enlisting help outside of the Technical Writing team. ## What is an infrastructure issue? The term "infrastructure" refers to the services tha... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/infrastructure.md | main | gitlab | [
-0.039081327617168427,
-0.023850709199905396,
0.06653708964586258,
0.009023196063935757,
-0.010933110490441322,
-0.15442602336406708,
-0.09800832718610764,
-0.047295838594436646,
0.01328361313790083,
0.024147531017661095,
-0.05391610041260719,
0.03839860484004021,
0.08608353137969971,
0.05... | 0.025239 |
in the `#gitlab-pages` channel if errors look related to the GitLab Pages service. 1. If the problem persists, or if you are unable to get a response in `#gitlab-pages`, [declare an incident](https://handbook.gitlab.com/handbook/engineering/infrastructure-platforms/incident-management/#reporting-an-incident) to engage ... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/infrastructure.md | main | gitlab | [
-0.08057871460914612,
-0.0009516210993751884,
0.01028513628989458,
0.0317956916987896,
-0.045838937163352966,
-0.1275799423456192,
0.006178702227771282,
-0.04749109968543053,
-0.005970420315861702,
0.007983280345797539,
0.015490175224840641,
0.012189269065856934,
0.13549070060253143,
0.041... | 0.007053 |
# Feedback forms The Docs "Was this page helpful?" feedback form is a Vue.js component that collects user feedback and stores it in a [Cloud Firestore](https://firebase.google.com/docs/firestore) database. In the event of a problem, see [Turn off the feedback form](#turn-off-the-feedback-form) below. ## Data flow 1. Us... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/feedback.md | main | gitlab | [
-0.10336653143167496,
0.04104483872652054,
0.013179845176637173,
0.02849351242184639,
0.010051760822534561,
0.019039854407310486,
-0.031792037189006805,
-0.013500330969691277,
0.025947298854589462,
0.011144572868943214,
-0.07671444118022919,
-0.012798315845429897,
0.026017382740974426,
-0.... | 0.016505 |
Request](https://gitlab.com/gitlab-com/gl-security/corp/issue-tracker/-/issues/new?issuable\_template=gcp\_services\_project\_iam\_update). ### Accessing the console 1. Visit [Firebase Console](https://console.firebase.google.com/). 2. Select the `ux-tech-writing-web-f169cc0e` project. Useful console links: - [`feedbac... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/feedback.md | main | gitlab | [
-0.03153029829263687,
-0.0017312044510617852,
-0.02495049498975277,
-0.01196037046611309,
0.0028049517422914505,
-0.0026673132088035345,
0.020982787013053894,
-0.02113834209740162,
-0.059598349034786224,
0.06093328446149826,
-0.010532385669648647,
-0.00027441949350759387,
0.07591047883033752... | 0.006679 |
# GitLab docs site maintenance Some of the issues that the GitLab technical writing team handles to maintain `https://docs.gitlab.com` include: - The deployment process. - Temporary event or survey banners. ## Deployment process We use [GitLab Pages](https://docs.gitlab.com/user/project/pages/) to build and host this w... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/maintenance.md | main | gitlab | [
-0.10453715175390244,
0.058677997440099716,
0.027581093832850456,
0.06928420811891556,
-0.006633734796196222,
-0.18259236216545105,
-0.042438965290784836,
-0.0653332769870758,
0.02461332269012928,
0.060208212584257126,
-0.02426900900900364,
0.019739121198654175,
0.09124265611171722,
-0.001... | 0.046176 |
it is used only for review apps or project maintenance. Prerequisites: - You must have at least the Maintainer role in the `docs-gitlab-com` project. To regenerate `DOCS\_TRIGGER\_TOKEN`: 1. Go to [\*\*Settings > CI/CD > Pipelines trigger tokens\*\*](https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/-/set... | https://gitlab.com/gitlab-org/technical-writing/docs-gitlab-com/blob/main/doc/maintenance.md | main | gitlab | [
-0.12229857593774796,
-0.008657023310661316,
0.010349620133638382,
0.0395376943051815,
-0.05172431841492653,
-0.06408625096082687,
0.029622482135891914,
0.003282981226220727,
0.05592087656259537,
0.031950291246175766,
-0.023939065635204315,
0.0012777193915098906,
0.08878808468580246,
-0.04... | 0.118232 |
# `smolagents`## What is smolagents? `smolagents` is an open-source Python library designed to make it extremely easy to build and run agents using just a few lines of code. Key features of `smolagents` include: ✨ \*\*Simplicity\*\*: The logic for agents fits in ~thousand lines of code. We kept abstractions to their mi... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/index.md | main | smolagents | [
-0.11115244030952454,
-0.013342616148293018,
-0.0848650187253952,
0.01982821524143219,
0.028873665258288383,
-0.09349118918180466,
-0.025518501177430153,
0.006164530757814646,
-0.031044811010360718,
-0.01288160216063261,
0.021802039816975594,
-0.007756686769425869,
0.011079719290137291,
-0... | 0.24715 |
[How-to guides Practical guides to help you achieve a specific goal: create an agent to generate and test SQL queries!](./examples/text_to_sql) [Conceptual guides High-level explanations for building a better understanding of important topics.](./conceptual_guides/intro_agents) [Tutorials Horizontal tutorials that cove... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/index.md | main | smolagents | [
0.029685845598578453,
-0.059748146682977676,
-0.07862924784421921,
0.02834145724773407,
-0.05581938102841377,
-0.012972977943718433,
0.03868991136550903,
0.05706408992409706,
-0.14843595027923584,
-0.010216467082500458,
0.0030287106055766344,
0.0033957301639020443,
0.07382666319608688,
-0.... | 0.079886 |
# Agents - Guided tour [[open-in-colab]] In this guided visit, you will learn how to build an agent, how to run it, and how to customize it to make it work better for your use-case. ## Choosing an agent type: CodeAgent or ToolCallingAgent `smolagents` comes with two agent classes: [`CodeAgent`] and [`ToolCallingAgent`]... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.06457087397575378,
-0.03602973744273186,
-0.10179640352725983,
0.023336810991168022,
-0.028067167848348618,
-0.06124042719602585,
-0.03221380338072777,
0.04860060289502144,
-0.012751955538988113,
-0.03391571342945099,
0.02053339220583439,
-0.027840077877044678,
0.045041535049676895,
-0.... | 0.137103 |
the page at url 'https://huggingface.co/blog'?") ``` Additionally, as an extra security layer, access to submodule is forbidden by default, unless explicitly authorized within the import list. For instance, to access the `numpy.random` submodule, you need to add `'numpy.random'` to the `additional\_authorized\_imports`... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.0928749218583107,
-0.000045922392018837854,
-0.023388762027025223,
-0.004449663683772087,
0.0753994807600975,
-0.09964126348495483,
-0.018661409616470337,
-0.014277905225753784,
-0.058183394372463226,
-0.003232028800994158,
0.02642926760017872,
-0.04914221912622452,
0.10203718394041061,
... | 0.058107 |
Bedrock](https://aws.amazon.com/bedrock/?nc1=h\_ls), or [mlx-lm](https://pypi.org/project/mlx-lm/). All model classes support passing additional keyword arguments (like `temperature`, `max\_tokens`, `top\_p`, etc.) directly at instantiation time. These parameters are automatically forwarded to the underlying model's co... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.052309393882751465,
-0.07658597826957703,
-0.06572975218296051,
0.03162512928247452,
0.0773143321275711,
-0.007276778109371662,
-0.009474343620240688,
0.05124298855662346,
0.006122216582298279,
0.037069909274578094,
0.04776586964726448,
-0.10655380040407181,
0.04234285652637482,
-0.0302... | 0.019327 |
integration with Amazon Bedrock, allowing for direct API calls and comprehensive configuration. Basic Usage: ```python # !pip install 'smolagents[bedrock]' from smolagents import CodeAgent, AmazonBedrockModel model = AmazonBedrockModel(model\_id="anthropic.claude-3-sonnet-20240229-v1:0") agent = CodeAgent(tools=[], mod... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.04102335497736931,
-0.01980258710682392,
-0.11519011110067368,
-0.006778818089514971,
0.03925574570894241,
-0.08588913828134537,
-0.07057648152112961,
0.035211142152547836,
-0.05579311400651932,
0.03504471853375435,
0.01628255471587181,
-0.08386118710041046,
-0.04212242364883423,
-0.017... | 0.109651 |
list of chat messages for the Model to view. This method goes over each step of the log and only stores what it's interested in as a message: for instance, it will save the system prompt and task in separate messages, then for each step it will store the LLM output as a message, and the tool call output as another mess... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.0019209090387448668,
-0.025922738015651703,
-0.022710075601935387,
0.002307393355295062,
0.03427854925394058,
-0.04353193938732147,
-0.0032703883480280638,
0.035805683583021164,
0.06052515655755997,
-0.006228393875062466,
-0.04801938310265541,
-0.035302143543958664,
0.033666327595710754,
... | 0.112917 |
next(iter(list\_models(filter=task, sort="downloads", direction=-1))) return most\_downloaded\_model.id ``` The function needs: - A clear name. The name should be descriptive enough of what this tool does to help the LLM brain powering the agent. Since this tool returns the model with the most downloads for a task, let... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.038876235485076904,
0.02225237898528576,
-0.018559446558356285,
0.025861790403723717,
0.03385399654507637,
0.018803032115101814,
0.113771952688694,
0.03355644270777702,
0.015333039686083794,
0.0055512008257210255,
-0.027043486014008522,
-0.009664228186011314,
0.007424617651849985,
-0.01... | 0.115739 |
systems have been introduced with Microsoft's framework [Autogen](https://huggingface.co/papers/2308.08155). In this type of framework, you have several agents working together to solve your task instead of only one. It empirically yields better performance on most benchmarks. The reason for this better performance is ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/guided_tour.md | main | smolagents | [
-0.036366287618875504,
-0.044590264558792114,
-0.09276658296585083,
0.04338311403989792,
-0.00794258527457714,
-0.05750396102666855,
-0.005168989300727844,
0.02438916079699993,
-0.020830076187849045,
-0.007890899665653706,
-0.030472366139292717,
-0.052588433027267456,
0.09493542462587357,
... | 0.12216 |
# Installation Options The `smolagents` library can be installed using pip. Here are the different installation methods and options available. ## Prerequisites - Python 3.10 or newer - Python package manager: [`pip`](https://pip.pypa.io/en/stable/) or [`uv`](https://docs.astral.sh/uv/) ## Virtual Environment It's stron... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/installation.md | main | smolagents | [
-0.08130574971437454,
-0.02151614800095558,
-0.018156813457608223,
-0.013924467377364635,
0.06732235103845596,
-0.04535403847694397,
-0.04754167050123215,
0.07268725335597992,
-0.07317902147769928,
-0.01850985176861286,
0.022416435182094574,
-0.04423154890537262,
-0.03709752857685089,
0.10... | 0.002051 |
``` - \*\*e2b\*\*: Enable E2B support for remote execution. ```bash uv pip install "smolagents[e2b]" ``` - \*\*docker\*\*: Add support for executing code in Docker containers. ```bash uv pip install "smolagents[docker]" ``` ### Telemetry and User Interface Extras for telemetry, monitoring and user interface components:... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/installation.md | main | smolagents | [
-0.009817507117986679,
0.04086390137672424,
-0.04851411655545235,
-0.03786204755306244,
0.03512527048587799,
-0.09593968838453293,
0.014375654049217701,
0.06381354480981827,
-0.03919088840484619,
0.026226941496133804,
0.00870451144874096,
-0.12641602754592896,
0.0015171635895967484,
0.0322... | 0.089222 |
# How do multi-step agents work? The ReAct framework ([Yao et al., 2022](https://huggingface.co/papers/2210.03629)) is currently the main approach to building agents. The name is based on the concatenation of two words, "Reason" and "Act." Indeed, agents following this architecture will solve their task in as many step... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/conceptual_guides/react.md | main | smolagents | [
-0.07006281614303589,
-0.029462089762091637,
-0.04472695663571358,
-0.012093859724700451,
0.02664102055132389,
-0.015854282304644585,
0.006144202314317226,
0.07481773942708969,
0.04382363334298134,
0.009963920339941978,
-0.02783670835196972,
-0.016882888972759247,
0.007656940259039402,
0.0... | 0.194389 |
# What are agents? 🤔 ## An introduction to agentic systems. Any efficient system using AI will need to provide LLMs some kind of access to the real world: for instance the possibility to call a search tool to get external information, or to act on certain programs in order to solve a task. In other words, LLMs should ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/conceptual_guides/intro_agents.md | main | smolagents | [
-0.022466687485575676,
-0.07748466730117798,
-0.08787563443183899,
-0.028262421488761902,
-0.0004181306285317987,
-0.025743860751390457,
0.021722646430134773,
-0.015688439831137657,
0.0649530440568924,
-0.0030690014827996492,
-0.03972354158759117,
-0.001189965521916747,
0.09334886819124222,
... | 0.211419 |
100% reliable system with no risk of error introduced by letting unpredictable LLMs meddle in your workflow. For the sake of simplicity and robustness, it's advised to regularize towards not using any agentic behaviour. But what if the workflow can't be determined that well in advance? For instance, a user wants to ask... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/conceptual_guides/intro_agents.md | main | smolagents | [
-0.04236620292067528,
-0.0025700817350298166,
0.03399894759058952,
-0.001123200636357069,
-0.004826146177947521,
-0.03104476071894169,
0.003949521109461784,
0.0006772213964723051,
0.02092875726521015,
0.0022201447281986475,
-0.06421780586242676,
-0.0024955752305686474,
0.05154658108949661,
... | 0.060505 |
calls to external tools. A common format (used by Anthropic, OpenAI, and many others) for writing these actions is generally different shades of "writing actions as a JSON of tools names and arguments to use, which you then parse to know which tool to execute and with which arguments". [Multiple](https://huggingface.co... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/conceptual_guides/intro_agents.md | main | smolagents | [
-0.09028122574090958,
-0.013345403596758842,
-0.025304142385721207,
-0.01586177945137024,
-0.004990681074559689,
-0.05963463708758354,
-0.0334533266723156,
0.04993290826678276,
0.07832779735326767,
0.03209087252616882,
-0.007347537204623222,
0.020744482055306435,
0.052841756492853165,
-0.0... | 0.134226 |
# Agentic RAG [[open-in-colab]] ## Introduction to Retrieval-Augmented Generation (RAG) Retrieval-Augmented Generation (RAG) combines the power of large language models with external knowledge retrieval to produce more accurate, factual, and contextually relevant responses. At its core, RAG is about "using an LLM to an... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/rag.md | main | smolagents | [
-0.042313333600759506,
-0.00929667055606842,
-0.004192085936665535,
0.01567157916724682,
-0.023566745221614838,
0.06295429915189743,
0.0139149259775877,
0.03267231211066246,
-0.013084014877676964,
-0.00999438762664795,
-0.017302626743912697,
0.0027478390838950872,
0.09101946651935577,
-0.0... | 0.156128 |
smaller chunks for better retrieval text\_splitter = RecursiveCharacterTextSplitter( chunk\_size=500, # Characters per chunk chunk\_overlap=50, # Overlap between chunks to maintain context add\_start\_index=True, strip\_whitespace=True, separators=["\n\n", "\n", ".", " ", ""], # Priority order for splitting ) docs\_pro... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/rag.md | main | smolagents | [
-0.07796941697597504,
0.0650319904088974,
0.021548831835389137,
0.05695078894495964,
-0.037093307822942734,
-0.03658558800816536,
0.003728386014699936,
0.0829324796795845,
-0.02751483954489231,
0.011261312291026115,
0.02156711556017399,
-0.019069653004407883,
0.057130321860313416,
-0.00260... | 0.053986 |
systems. The approach we've demonstrated: - Overcomes the limitations of single-step retrieval - Enables more natural interactions with knowledge bases - Provides a framework for continuous improvement through self-critique and query refinement As you build your own Agentic RAG systems, consider experimenting with diff... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/rag.md | main | smolagents | [
-0.007880669087171555,
0.055105894804000854,
-0.0633099228143692,
0.012935652397572994,
-0.06471487879753113,
0.029665805399417877,
0.03977993503212929,
0.05894722044467926,
0.006875340826809406,
-0.013032419607043266,
-0.04547320678830147,
0.026633430272340775,
0.1252627670764923,
0.05588... | 0.17901 |
# Web Browser Automation with Agents 🤖🌐 [[open-in-colab]] In this notebook, we'll create an \*\*agent-powered web browser automation system\*\*! This system can navigate websites, interact with elements, and extract information automatically. The agent will be able to: - [x] Navigate to web pages - [x] Click on eleme... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/web_browser.md | main | smolagents | [
-0.0846109390258789,
-0.02354993112385273,
-0.05683756247162819,
0.02463345415890217,
0.0569244809448719,
-0.03573125973343849,
0.025068499147892,
0.01739632897078991,
-0.07136499136686325,
-0.11538901180028915,
0.026245566084980965,
-0.05123418942093849,
0.0699613019824028,
-0.01879388839... | 0.095391 |
click clickable elements by inputting the text that appears on them. Code: ```py click("Top products") ``` If it's a link: Code: ```py click(Link("Top products")) ``` If you try to interact with an element and it's not found, you'll get a LookupError. In general stop your action after each button click to see what happ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/web_browser.md | main | smolagents | [
-0.09632996469736099,
0.013037036173045635,
-0.04064822569489479,
-0.023676598444581032,
0.09173426777124405,
-0.03359225392341614,
0.07432683557271957,
0.05354663357138634,
-0.021107813343405724,
-0.036731887608766556,
0.02128199115395546,
0.06313470005989075,
0.10381249338388443,
-0.0347... | -0.003906 |
# Orchestrate a multi-agent system 🤖🤝🤖 [[open-in-colab]] In this notebook we will make a \*\*multi-agent web browser: an agentic system with several agents collaborating to solve problems using the web!\*\* It will be a simple hierarchy: ``` +----------------+ | Manager agent | +----------------+ | \_\_\_\_\_\_\_\_\... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/multiagents.md | main | smolagents | [
-0.07742960005998611,
-0.0764247328042984,
-0.06302643567323685,
-0.023624682798981667,
-0.04815743491053581,
-0.013690131716430187,
0.011563747189939022,
0.00047218016698025167,
-0.04280363768339157,
-0.018020179122686386,
0.05016518011689186,
-0.07641474902629852,
0.031450849026441574,
0... | 0.083306 |
work well. Also, we want to ask a question that involves the current year and does additional data calculations: so let us add `additional\_authorized\_imports=["time", "numpy", "pandas"]`, just in case the agent needs these packages. ```py manager\_agent = CodeAgent( tools=[], model=model, managed\_agents=[web\_agent]... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/multiagents.md | main | smolagents | [
-0.05456303432583809,
0.026242174208164215,
-0.07484482228755951,
0.05268251523375511,
0.01049269549548626,
-0.06968928873538971,
-0.03528861701488495,
0.030956296250224113,
-0.11396847665309906,
0.0317191518843174,
0.009408916346728802,
-0.05296168103814125,
-0.020336391404271126,
-0.0175... | 0.038122 |
# Human-in-the-Loop: Customize Agent Plan Interactively This page demonstrates advanced usage of the smolagents library, with a special focus on \*\*Human-in-the-Loop (HITL)\*\* approaches for interactive plan creation, user-driven plan modification, and memory preservation in agentic workflows. The example is based on... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/plan_customization.md | main | smolagents | [
-0.07260455936193466,
0.014565698802471161,
-0.09430135786533356,
0.0358603410422802,
-0.03637319430708885,
-0.048046112060546875,
0.014631325379014015,
0.02709132432937622,
-0.03466976061463356,
0.0013344334438443184,
0.002404022729024291,
0.03939007595181465,
-0.024140574038028717,
-0.03... | 0.130722 |
# Async Applications with Agents This guide demonstrates how to integrate a synchronous agent from the `smolagents` library into an asynchronous Python web application using Starlette. The example is designed to help users new to async Python and agent integration understand best practices for combining synchronous age... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/async_agent.md | main | smolagents | [
-0.1300499439239502,
-0.028602102771401405,
-0.11960744857788086,
0.07954967021942139,
-0.02021637000143528,
-0.10806725919246674,
-0.028673740103840828,
-0.034302473068237305,
-0.02446843311190605,
-0.05079777538776398,
-0.001594229252077639,
0.0005779087077826262,
0.005314955487847328,
-... | 0.169374 |
# Using different models [[open-in-colab]] `smolagents` provides a flexible framework that allows you to use various language models from different providers. This guide will show you how to use different model types with your agents. ## Available model types `smolagents` supports several model types out of the box: 1.... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/using_different_models.md | main | smolagents | [
-0.033734384924173355,
-0.09851621091365814,
-0.02446209453046322,
0.017635678872466087,
0.03331494703888893,
0.007093994412571192,
-0.05694475769996643,
0.0005508470931090415,
0.024294335395097733,
0.0006369411712512374,
0.0025274569634348154,
-0.08437003195285797,
0.03384529799222946,
0.... | 0.163237 |
# Text-to-SQL [[open-in-colab]] In this tutorial, we’ll see how to implement an agent that leverages SQL using `smolagents`. > Let's start with the golden question: why not keep it simple and use a standard text-to-SQL pipeline? A standard text-to-sql pipeline is brittle, since the generated SQL query can be incorrect.... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/text_to_sql.md | main | smolagents | [
-0.056377459317445755,
-0.05615480989217758,
-0.04588739573955536,
0.07411976903676987,
-0.06097334995865822,
-0.05540743097662926,
0.050800010561943054,
0.0447479784488678,
-0.04578801989555359,
-0.028662795200943947,
-0.031142892315983772,
-0.051261793822050095,
0.05001407861709595,
-0.0... | 0.082175 |
) agent.run("Can you give me the name of the client who got the most expensive receipt?") ``` ### Level 2: Table joins Now let’s make it more challenging! We want our agent to handle joins across multiple tables. So let’s make a second table recording the names of waiters for each receipt\_id! ```py table\_name = "wait... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/examples/text_to_sql.md | main | smolagents | [
0.0021256518084555864,
0.07834689319133759,
-0.013552333228290081,
0.0014372658915817738,
-0.03330572694540024,
-0.05468859523534775,
0.06203969195485115,
0.05885981023311615,
-0.05694425478577614,
-0.018126215785741806,
0.0012938248692080379,
-0.05192374438047409,
0.04142872989177704,
-0.... | -0.01997 |
# Secure code execution [[open-in-colab]] > [!TIP] > If you're new to building agents, make sure to first read the [intro to agents](../conceptual\_guides/intro\_agents) and the [guided tour of smolagents](../guided\_tour). ### Code agents [Multiple](https://huggingface.co/papers/2402.01030) [research](https://huggingf... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/secure_code_execution.md | main | smolagents | [
-0.14111775159835815,
-0.017290521413087845,
-0.07132244855165482,
-0.010537064634263515,
0.005478483624756336,
-0.03684039041399956,
-0.04308729246258736,
0.07642041891813278,
0.05952288582921028,
-0.019179360941052437,
0.02366657927632332,
0.00920263584703207,
-0.0014281908515840769,
0.0... | 0.155019 |
To add a first layer of security, code execution in `smolagents` is not performed by the vanilla Python interpreter. We have re-built a more secure `LocalPythonExecutor` from the ground up. To be precise, this interpreter works by loading the Abstract Syntax Tree (AST) from your Code and executes it operation by operat... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/secure_code_execution.md | main | smolagents | [
-0.10164466500282288,
-0.005213862285017967,
-0.05464542657136917,
0.028071440756320953,
0.00781176658347249,
-0.09948219358921051,
-0.009983787313103676,
0.042040180414915085,
-0.07500984519720078,
-0.026753878220915794,
0.028293181210756302,
-0.040345557034015656,
0.039993174374103546,
0... | 0.138159 |
remote execution sandbox. ## Sandbox approaches for secure code execution When working with AI agents that execute code, security is paramount. There are two main approaches to sandboxing code execution in smolagents, each with different security properties and capabilities:  would require model calls, since we do not transfer secrets to the remote sandbox, the model call would lack credentials. Hence this solution does not work (yet) with more complicated multi-agent s... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/secure_code_execution.md | main | smolagents | [
0.026584357023239136,
-0.038001079112291336,
-0.02844257280230522,
-0.00852294359356165,
-0.001037304988130927,
-0.02982161194086075,
-0.04230232909321785,
0.0159438643604517,
-0.03765169158577919,
-0.009347504936158657,
0.006704920437186956,
-0.13810233771800995,
0.07973691821098328,
-0.0... | 0.051853 |
```python import docker import os from typing import Optional class DockerSandbox: def \_\_init\_\_(self): self.client = docker.from\_env() self.container = None def create\_container(self): try: image, build\_logs = self.client.images.build( path=".", tag="agent-sandbox", rm=True, forcerm=True, buildargs={}, # decode=... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/secure_code_execution.md | main | smolagents | [
0.07137007266283035,
0.07732393592596054,
0.01769072934985161,
-0.0008619582513347268,
0.07498938590288162,
-0.09535438567399979,
0.004301265813410282,
0.022651294246315956,
-0.0020215578842908144,
0.027555523440241814,
-0.013546631671488285,
-0.07813674956560135,
0.061941467225551605,
0.0... | 0.009425 |
# Inspecting runs with OpenTelemetry [[open-in-colab]] > [!TIP] > If you're new to building agents, make sure to first read the [intro to agents](../conceptual\_guides/intro\_agents) and the [guided tour of smolagents](../guided\_tour). ## Why log your agent runs? Agent runs are complicated to debug. Validating that a ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/inspect_runs.md | main | smolagents | [
-0.013094433583319187,
-0.027953535318374634,
-0.05864390730857849,
0.012373953126370907,
0.04501063749194145,
-0.08967006951570511,
-0.020770063623785973,
0.015072476118803024,
-0.023614197969436646,
-0.009808565489947796,
-0.04016052559018135,
-0.049684789031744,
-0.018507516011595726,
0... | 0.17902 |
[Langfuse](https://langfuse.com) is an open-source platform for LLM engineering. It provides tracing and monitoring capabilities for AI agents, helping developers debug, analyze, and optimize their products. Langfuse integrates with various tools and frameworks via native integrations, OpenTelemetry, and SDKs. ### Step... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/inspect_runs.md | main | smolagents | [
-0.06712450087070465,
-0.0524832047522068,
0.06517418473958969,
0.012994538061320782,
0.026768051087856293,
-0.11783462762832642,
0.004771921318024397,
0.05254789814352989,
0.0005351693835109472,
-0.0025120521895587444,
-0.01286396849900484,
-0.09882491081953049,
-0.010012741200625896,
0.0... | 0.171034 |
# 📚 Manage your agent's memory [[open-in-colab]] In the end, an agent can be defined by simple components: it has tools, prompts. And most importantly, it has a memory of past steps, drawing a history of planning, execution, and errors. ### Replay your agent's memory We propose several features to inspect a past agent... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/memory.md | main | smolagents | [
-0.00483829528093338,
-0.01758713833987713,
-0.13242147862911224,
0.0449676439166069,
-0.02051156386733055,
0.02993961051106453,
-0.02134852297604084,
0.0692213848233223,
0.015385745093226433,
0.0031863958574831486,
-0.01564604602754116,
-0.015348805114626884,
0.018156500533223152,
-0.0071... | 0.149097 |
step\_number += 1 # Change the memory as you please! # For instance to update the latest step: # agent.memory.steps[-1] = ... print("The final answer is:", final\_answer) ``` | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/memory.md | main | smolagents | [
-0.004666041117161512,
0.08548647910356522,
-0.05800139531493187,
0.04267004504799843,
-0.06646949797868729,
0.01437873113900423,
0.011254449374973774,
0.0556957870721817,
-0.03395417332649231,
0.003779643215239048,
0.017957359552383423,
0.02993207797408104,
0.03730473294854164,
-0.0743084... | 0.069907 |
# Building good agents [[open-in-colab]] There's a world of difference between building an agent that works and one that doesn't. How can we build agents that fall into the former category? In this guide, we're going to talk about best practices for building agents. > [!TIP] > If you're new to building agents, make sur... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/building_good_agents.md | main | smolagents | [
-0.015507664531469345,
-0.03645189106464386,
-0.022085610777139664,
-0.023172477260231972,
0.006722731981426477,
-0.06680380553007126,
-0.006513052154332399,
0.025538338348269463,
-0.011099392548203468,
-0.016529444605112076,
-0.026659168303012848,
-0.05717490613460541,
0.07519298046827316,
... | 0.130361 |
not being in a proper format, or date\_time not being properly formatted. - the output format is hard to understand If the tool call fails, the error trace logged in memory can help the LLM reverse engineer the tool to fix the errors. But why leave it with so much heavy lifting to do? A better way to build this tool wo... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/building_good_agents.md | main | smolagents | [
0.02922370471060276,
0.055353887379169464,
-0.004768159240484238,
0.08798135817050934,
0.019625216722488403,
-0.08696309477090836,
-0.01077614352107048,
0.058804549276828766,
-0.05953191965818405,
-0.009473850950598717,
-0.009698580019176006,
-0.08714894205331802,
0.04585496708750725,
0.00... | -0.020364 |
wouldn't have made that mistake. ### 2. Provide more information or specific instructions You can also use less powerful models, provided you guide them more effectively. Put yourself in the shoes of your model: if you were the model solving the task, would you struggle with the information available to you (from the s... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/building_good_agents.md | main | smolagents | [
0.0059708161279559135,
0.040510185062885284,
-0.006424549967050552,
-0.023671718314290047,
-0.02250811643898487,
0.021149897947907448,
-0.015297658741474152,
0.0814291462302208,
-0.07379162311553955,
0.0801609680056572,
0.006114888470619917,
-0.02838006801903248,
0.06542317569255829,
-0.01... | 0.076544 |
variable `question` about the image stored in the variable `image`. The question is in French. You have been provided with these additional arguments, that you can access using the keys as variables in your python code: {'question': 'Quel est l'animal sur l'image?', 'image': 'path/to/image.jpg'}" Thought: I will use th... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/building_good_agents.md | main | smolagents | [
-0.039794713258743286,
0.08919926732778549,
-0.025747938081622124,
0.05212435498833656,
-0.007858464494347572,
-0.04338071867823601,
0.0875353142619133,
0.10363901406526566,
0.028592463582754135,
-0.04148029908537865,
0.026530897244811058,
-0.06195541098713875,
0.053570911288261414,
0.0869... | 0.0536 |
%} {{ tool.to\_code\_prompt() }} {% endfor %} {{code\_block\_closing\_tag}} {%- if managed\_agents and managed\_agents.values() | list %} You can also give tasks to team members. Calling a team member works similarly to calling a tool: provide the task description as the 'task' argument. Since this team member is a rea... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/building_good_agents.md | main | smolagents | [
-0.007527414709329605,
0.061331991106271744,
-0.093434639275074,
0.024409597739577293,
0.015963884070515633,
-0.07182645052671432,
0.06421912461519241,
0.0306317750364542,
-0.046743154525756836,
0.009885544888675213,
-0.030146917328238487,
-0.062080658972263336,
0.029642099514603615,
0.067... | 0.077248 |
following placeholders: - To insert tool descriptions: ``` {%- for tool in tools.values() %} - {{ tool.to\_tool\_calling\_prompt() }} {%- endfor %} ``` - To insert the descriptions for managed agents if there are any: ``` {%- if managed\_agents and managed\_agents.values() | list %} You can also give tasks to team memb... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/building_good_agents.md | main | smolagents | [
0.007540109567344189,
0.027825884521007538,
-0.08902525156736374,
0.030625073239207268,
-0.03526214882731438,
-0.014952176250517368,
0.0696880891919136,
0.04899884760379791,
-0.05451849848031998,
0.016721626743674278,
-0.029146581888198853,
-0.1090308204293251,
0.07273847609758377,
0.09098... | 0.069259 |
# Tools [[open-in-colab]] Here, we're going to see advanced tool usage. > [!TIP] > If you're new to building agents, make sure to first read the [intro to agents](../conceptual\_guides/intro\_agents) and the [guided tour of smolagents](../guided\_tour). ### What is a tool, and how to build one? A tool is mostly a funct... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/tools.md | main | smolagents | [
-0.046613916754722595,
-0.05502194166183472,
-0.11095479130744934,
0.002596429781988263,
-0.013506138697266579,
-0.022626059129834175,
-0.02014932595193386,
0.059480857104063034,
-0.012917093001306057,
-0.028466153889894485,
-0.003220901358872652,
-0.055179793387651443,
0.05042147636413574,
... | 0.204599 |
initialization are hard to track, which prevents from sharing them properly to the hub. And anyway, the idea of making a specific class is that you can already set class attributes for anything you need to hard-code (just set `your\_variable=(...)` directly under the `class YourTool(Tool):` line). And of course you can... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/tools.md | main | smolagents | [
-0.046131834387779236,
-0.032191965728998184,
-0.15131476521492004,
0.0160734411329031,
-0.0022551952861249447,
0.0175190269947052,
-0.02750268578529358,
0.05163877084851265,
-0.08232621103525162,
-0.03954015299677849,
0.08446896821260452,
-0.024857161566615105,
0.04512474685907364,
-0.019... | 0.013245 |
(2025-06-18+)](https://modelcontextprotocol.io/specification/2025-06-18/server/tools#structured-content) include support for `outputSchema`, which enables tools to return structured data with defined schemas. `smolagents` takes advantage of these structured output capabilities, allowing agents to work with tools that r... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/tools.md | main | smolagents | [
-0.004486857447773218,
-0.02010008506476879,
-0.059586051851511,
0.07210531830787659,
0.020933041349053383,
-0.0777084231376648,
-0.07318998873233795,
-0.0022049027029424906,
-0.029920805245637894,
-0.012595218606293201,
0.02060418203473091,
-0.12622511386871338,
0.022296488285064697,
-0.0... | 0.126646 |
to the agent. ```python from smolagents import CodeAgent, InferenceClientModel model = InferenceClientModel(model\_id="Qwen/Qwen3-Next-80B-A3B-Thinking") agent = CodeAgent(tools=[image\_generation\_tool], model=model) agent.run( "Improve this prompt, then generate an image of it.", additional\_args={'user\_prompt': 'A ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/tools.md | main | smolagents | [
-0.02527032233774662,
0.016248399391770363,
0.026995165273547173,
0.03542259708046913,
0.05073564872145653,
-0.04392603039741516,
0.06266851723194122,
0.013212649151682854,
-0.004786815494298935,
0.011997565627098083,
0.05362049117684364,
-0.11050152778625488,
0.12435191124677658,
0.015778... | 0.018411 |
with ToolCollection.from\_mcp(server\_parameters, trust\_remote\_code=True, structured\_output=True) as tool\_collection: agent = CodeAgent(tools=[\*tool\_collection.tools], model=model, add\_base\_tools=True) agent.run("Please find a remedy for hangover.") ``` For Streamable HTTP-based MCP servers, simply pass a dict ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/tutorials/tools.md | main | smolagents | [
-0.057540930807590485,
-0.009692653082311153,
-0.06007205322384834,
0.036864444613456726,
-0.012602395378053188,
-0.07170064747333527,
0.0067559219896793365,
0.028062226250767708,
-0.04490484669804573,
-0.02751065418124199,
0.034024570137262344,
-0.0603264644742012,
0.006456669885665178,
-... | 0.026042 |
# Built-in Tools Ready-to-use tool implementations provided by the `smolagents` library. These built-in tools are concrete implementations of the [`Tool`] base class, each designed for specific tasks such as web searching, Python code execution, webpage retrieval, and user interaction. You can use these tools directly ... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/reference/default_tools.md | main | smolagents | [
-0.07924032211303711,
-0.02035975642502308,
-0.07154247164726257,
0.03541776165366173,
-0.0004810671089217067,
-0.05724651366472244,
-0.018976904451847076,
-0.03628862649202347,
-0.0450778491795063,
-0.061744656413793564,
0.019152546301484108,
-0.02457396499812603,
0.05352342873811722,
-0.... | 0.136811 |
# Python code executors Python executors are responsible for running the code generated by code agents in a controlled environment. Since agents dynamically generate and execute Python code to accomplish tasks, choosing the right executor is critical for both functionality and security. To learn more about code executi... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/reference/python_executors.md | main | smolagents | [
-0.09215295314788818,
0.02344420924782753,
-0.08367888629436493,
0.01951625943183899,
-0.06137896329164505,
-0.10476641356945038,
-0.07448433339595795,
0.013615802861750126,
0.01867745630443096,
0.02357724867761135,
0.035653527826070786,
-0.030986545607447624,
0.003540637204423547,
-0.0007... | 0.121279 |
# Models Smolagents is an experimental API which is subject to change at any time. Results returned by the agents can vary as the APIs or underlying models are prone to change. To learn more about agents and tools make sure to read the [introductory guide](../index). This page contains the API docs for the underlying c... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/reference/models.md | main | smolagents | [
-0.13325417041778564,
-0.06803931295871735,
-0.03633127361536026,
0.10420513153076172,
0.015816083177924156,
-0.03499889746308327,
-0.061478398740291595,
0.04706910625100136,
0.010290883481502533,
-0.006201896816492081,
-0.0030934505630284548,
-0.05410033091902733,
0.004591772798448801,
-0... | 0.315242 |
model\_list=[ { "model\_name": "llama-3.3-70b", "litellm\_params": {"model": "groq/llama-3.3-70b", "api\_key": os.getenv("GROQ\_API\_KEY")}, }, { "model\_name": "llama-3.3-70b", "litellm\_params": {"model": "cerebras/llama-3.3-70b", "api\_key": os.getenv("CEREBRAS\_API\_KEY")}, }, ], client\_kwargs={ "routing\_strategy... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/reference/models.md | main | smolagents | [
-0.00709922332316637,
0.037831392139196396,
-0.050674665719270706,
0.05359258875250816,
-0.034507010132074356,
-0.008550254628062248,
0.010147623717784882,
0.042894601821899414,
0.008922009728848934,
-0.02666907198727131,
0.043821386992931366,
-0.07882571965456009,
0.028801513835787773,
-0... | 0.041232 |
# Agents Smolagents is an experimental API which is subject to change at any time. Results returned by the agents can vary as the APIs or underlying models are prone to change. To learn more about agents and tools make sure to read the [introductory guide](../index). This page contains the API docs for the underlying c... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/reference/agents.md | main | smolagents | [
-0.1377386450767517,
-0.041351351886987686,
-0.06528148055076599,
0.01538065355271101,
0.003289933083578944,
-0.03786593675613403,
-0.06015695631504059,
0.05162478983402252,
-0.026577269658446312,
-0.037377696484327316,
-0.006409204564988613,
-0.02789865806698799,
-0.02428489178419113,
0.0... | 0.202211 |
# Tools Smolagents is an experimental API which is subject to change at any time. Results returned by the agents can vary as the APIs or underlying models are prone to change. To learn more about agents and tools make sure to read the [introductory guide](../index). This page contains the API docs for the underlying cl... | https://github.com/huggingface/smolagents/blob/main/docs/source/en/reference/tools.md | main | smolagents | [
-0.102787546813488,
-0.039993561804294586,
-0.053870201110839844,
-0.018176738172769547,
0.0118936812505126,
-0.06227419897913933,
-0.040257617831230164,
0.03777477517724037,
-0.026031428948044777,
-0.015847116708755493,
0.05080028623342514,
-0.06162641942501068,
-0.023038366809487343,
-0.... | 0.180998 |
# Examples Check out a variety of sample implementations of the SDK in the examples section of the [repo](https://github.com/openai/openai-agents-python/tree/main/examples). The examples are organized into several categories that demonstrate different patterns and capabilities. ## Categories - \*\*[agent\_patterns](htt... | https://github.com/openai/openai-agents-python/blob/main/docs/examples.md | main | openai-agents | [
-0.04477971792221069,
-0.02192520536482334,
-0.10489962995052338,
0.0067933546379208565,
0.03644119203090668,
-0.07010219246149063,
-0.012552297674119473,
0.005050860345363617,
0.003922059666365385,
-0.027540748938918114,
-0.009421869181096554,
-0.06024165078997612,
0.028103193268179893,
0... | 0.212013 |
flows - \*\*[reasoning\_content](https://github.com/openai/openai-agents-python/tree/main/examples/reasoning\_content):\*\* Examples demonstrating how to work with reasoning content, including: - Reasoning content with the Runner API, streaming and non-streaming (`examples/reasoning\_content/runner\_example.py`) - Reas... | https://github.com/openai/openai-agents-python/blob/main/docs/examples.md | main | openai-agents | [
-0.05693240836262703,
-0.043737657368183136,
-0.06622616201639175,
0.011139287613332272,
0.07588807493448257,
-0.09312471002340317,
-0.03534793481230736,
0.041270650923252106,
0.001804941683076322,
-0.006555133033543825,
-0.030679838731884956,
-0.04346660152077675,
0.0161513090133667,
0.06... | 0.169778 |
# Guardrails Guardrails enable you to do checks and validations of user input and agent output. For example, imagine you have an agent that uses a very smart (and hence slow/expensive) model to help with customer requests. You wouldn't want malicious users to ask the model to help them with their math homework. So, you... | https://github.com/openai/openai-agents-python/blob/main/docs/guardrails.md | main | openai-agents | [
-0.036931514739990234,
0.036276161670684814,
-0.011784383095800877,
0.01831665262579918,
0.04452981427311897,
-0.025621449574828148,
0.040394168347120285,
0.004961253143846989,
0.01926274038851261,
0.00766949076205492,
0.032463040202856064,
0.004625590052455664,
0.06468985229730606,
-0.004... | 0.130472 |
is the \*last\* agent. Similar to the input guardrails, we do this because guardrails tend to be related to the actual Agent - you'd run different guardrails for different agents, so colocating the code is useful for readability. Output guardrails always run after the agent completes, so they don't support the `run\_in... | https://github.com/openai/openai-agents-python/blob/main/docs/guardrails.md | main | openai-agents | [
-0.0997803807258606,
0.010060838423669338,
-0.056047484278678894,
0.013979376293718815,
-0.007874519564211369,
-0.0012941270833835006,
0.025858836248517036,
0.020452870056033134,
0.01901312544941902,
-0.012268061749637127,
0.06961588561534882,
-0.02481919527053833,
0.02614951878786087,
-0.... | 0.078676 |
async def main(): # This should trip the guardrail try: await Runner.run(agent, "Hello, can you help me solve for x: 2x + 3 = 11?") print("Guardrail didn't trip - this is unexpected") except OutputGuardrailTripwireTriggered: print("Math output guardrail tripped") ``` 1. This is the actual agent's output type. 2. This i... | https://github.com/openai/openai-agents-python/blob/main/docs/guardrails.md | main | openai-agents | [
-0.10392675548791885,
0.044556934386491776,
-0.0801374763250351,
0.06537244468927383,
0.02280658669769764,
-0.03474519029259682,
0.025544414296746254,
0.014898164197802544,
-0.0492938831448555,
-0.06484120339155197,
-0.0006070274976082146,
-0.025350425392389297,
0.009300504811108112,
0.032... | 0.115527 |
# Model context protocol (MCP) The [Model context protocol](https://modelcontextprotocol.io/introduction) (MCP) standardises how applications expose tools and context to language models. From the official documentation: > MCP is an open protocol that standardizes how applications provide context to LLMs. Think of MCP l... | https://github.com/openai/openai-agents-python/blob/main/docs/mcp.md | main | openai-agents | [
-0.03819134458899498,
-0.057215187698602676,
-0.027913682162761688,
-0.000325209490256384,
0.00037154791061766446,
-0.043102942407131195,
-0.02864384464919567,
0.1051875501871109,
0.012753968127071857,
-0.028839951381087303,
-0.0028805250767618418,
-0.011353162117302418,
0.09476332366466522,... | 0.211153 |
server tools Hosted tools push the entire tool round-trip into OpenAI's infrastructure. Instead of your code listing and calling tools, the [`HostedMCPTool`][agents.tool.HostedMCPTool] forwards a server label (and optional connector metadata) to the Responses API. The model lists the remote server's tools and invokes t... | https://github.com/openai/openai-agents-python/blob/main/docs/mcp.md | main | openai-agents | [
-0.09696987271308899,
-0.00027355109341442585,
-0.07703647762537003,
0.08954760432243347,
-0.00308382511138916,
-0.13476228713989258,
-0.09249470382928848,
-0.01817569136619568,
0.012347571551799774,
-0.02292889729142189,
0.009332405403256416,
-0.019592830911278725,
0.035392358899116516,
-... | 0.100481 |
answer the questions.", mcp\_servers=[server], model\_settings=ModelSettings(tool\_choice="required"), ) result = await Runner.run(agent, "Add 7 and 22.") print(result.final\_output) asyncio.run(main()) ``` The constructor accepts additional options: - `client\_session\_timeout\_seconds` controls HTTP read timeouts. - ... | https://github.com/openai/openai-agents-python/blob/main/docs/mcp.md | main | openai-agents | [
-0.05161099508404732,
0.018752802163362503,
-0.06899341195821762,
0.13519737124443054,
-0.033631160855293274,
-0.06429991871118546,
-0.09908077120780945,
-0.004440899007022381,
-0.07856494188308716,
0.0038089666049927473,
0.02626284770667553,
-0.06922952830791473,
0.009189862757921219,
-0.... | 0.104878 |
to you.") print(result.final\_output) ``` ## 5. MCP server manager When you have multiple MCP servers, use `MCPServerManager` to connect them up front and expose the connected subset to your agents. See the [MCPServerManager API reference](ref/mcp/manager.md) for constructor options and reconnect behavior. ```python fr... | https://github.com/openai/openai-agents-python/blob/main/docs/mcp.md | main | openai-agents | [
-0.016933664679527283,
-0.013683151453733444,
0.007084617391228676,
0.08452010154724121,
-0.04948478937149048,
-0.03639160469174385,
-0.05724415183067322,
-0.046352967619895935,
-0.01645210199058056,
-0.03622127324342728,
-0.01566932536661625,
-0.013903198763728142,
0.05529775843024254,
-0... | 0.038129 |
# Context management Context is an overloaded term. There are two main classes of context you might care about: 1. Context available locally to your code: this is data and dependencies you might need when tool functions run, during callbacks like `on\_handoff`, in lifecycle hooks, etc. 2. Context available to LLMs: thi... | https://github.com/openai/openai-agents-python/blob/main/docs/context.md | main | openai-agents | [
-0.03407768905162811,
-0.025707358494400978,
-0.05234749987721443,
0.02773733250796795,
0.00962881464511156,
-0.10704439878463745,
0.07317563891410828,
0.05123046040534973,
-0.03451467677950859,
-0.03437528759241104,
0.009045534767210484,
-0.051967862993478775,
0.09275062382221222,
-0.0056... | 0.065264 |
\_\_name\_\_ == "\_\_main\_\_": asyncio.run(main()) ``` 1. This is the context object. We've used a dataclass here, but you can use any type. 2. This is a tool. You can see it takes a `RunContextWrapper[UserInfo]`. The tool implementation reads from the context. 3. We mark the agent with the generic `UserInfo`, so that... | https://github.com/openai/openai-agents-python/blob/main/docs/context.md | main | openai-agents | [
-0.04955417290329933,
0.03134807199239731,
-0.1289140284061432,
0.10033795237541199,
-0.05882023647427559,
-0.10005687922239304,
0.04698873311281204,
0.04090635105967522,
-0.12924174964427948,
-0.07965684682130814,
0.03473866358399391,
-0.07177755981683731,
-0.006313837133347988,
0.0135713... | 0.186211 |
databases (retrieval), or from the web (web search). This is useful for "grounding" the response in relevant contextual data. | https://github.com/openai/openai-agents-python/blob/main/docs/context.md | main | openai-agents | [
-0.01704358495771885,
-0.04190177470445633,
-0.09269682317972183,
0.03700678423047066,
-0.0016642097616568208,
-0.01080810371786356,
-0.023941636085510254,
0.0893198773264885,
0.014573966152966022,
-0.009810985997319221,
0.031866900622844696,
0.01597202569246292,
0.08329738676548004,
0.011... | 0.258251 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.