github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.9] [DOCS] Document Generative AI Token Usage dashboard in Gen AI connector (#162374) (#162585)

Browse source 
# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Document Generative AI Token Usage dashboard in Gen AI
connector (#162374)](https://github.com/elastic/kibana/pull/162374)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Joe
Peeples","email":"joe.peeples@elastic.co"},"sourceCommit":{"committedDate":"2023-07-26T15:55:16Z","message":"[DOCS]
Document Generative AI Token Usage dashboard in Gen AI connector
(#162374)\n\n## Summary\r\n\r\nContributes to
https://github.com/elastic/security-docs/pull/3549;\r\ndocuments the new
Generative AI Token Usage dashboard.\r\n\r\nPreview: [Generative AI
connector | Token
usage\r\ndashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)","sha":"34e6997432c389a3a7e0b41a1267b7a3bf4a29e8","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.9.0","v8.10.0","Feature:GenAI"],"number":162374,"url":"https://github.com/elastic/kibana/pull/162374","mergeCommit":{"message":"[DOCS]
Document Generative AI Token Usage dashboard in Gen AI connector
(#162374)\n\n## Summary\r\n\r\nContributes to
https://github.com/elastic/security-docs/pull/3549;\r\ndocuments the new
Generative AI Token Usage dashboard.\r\n\r\nPreview: [Generative AI
connector | Token
usage\r\ndashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)","sha":"34e6997432c389a3a7e0b41a1267b7a3bf4a29e8"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/162374","number":162374,"mergeCommit":{"message":"[DOCS]
Document Generative AI Token Usage dashboard in Gen AI connector
(#162374)\n\n## Summary\r\n\r\nContributes to
https://github.com/elastic/security-docs/pull/3549;\r\ndocuments the new
Generative AI Token Usage dashboard.\r\n\r\nPreview: [Generative AI
connector | Token
usage\r\ndashboard](https://kibana_162374.docs-preview.app.elstc.co/guide/en/kibana/master/gen-ai-action-type.html#gen-ai-connector-token-dashboard)","sha":"34e6997432c389a3a7e0b41a1267b7a3bf4a29e8"}}]}]
BACKPORT-->

Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
This commit is contained in:
Kibana Machine 2023-07-26 12:21:17 -04:00 • committed by GitHub
parent 6e4f1ed4d9
commit 882e5d4366
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/management/connectors/action-types/gen-ai.asciidoc
View file

@ -86,4 +86,12 @@ Body:: A JSON payload sent to the OpenAI API URL. For example:
[[gen-ai-connector-networking-configuration]]
=== Connector networking configuration
Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
Use the <<action-settings, Action configuration settings>> to customize connector networking configurations, such as proxies, certificates, or TLS settings. You can set configurations that apply to all your connectors or use `xpack.actions.customHostSettings` to set per-host configurations.
[float]
[[gen-ai-connector-token-dashboard]]
=== Token usage dashboard
Once you've created a Generative AI connector, you can monitor its token usage using the *Generative AI Token Usage* dashboard. Select the connector in *{stack-manage-app}* > *{connectors-ui}* to view its details, then click the *View OpenAI Usage Dashboard for "_<Name>_" Connector* link to open the dashboard.
NOTE: To view the dashboard, you need at least `read` and `view_index_metadata` privileges for the `.kibana-event-log-*` index and the `Read` feature privilege for {kib}. You can set up a role with these minimum privileges and assign it to non-admin users who need to view this dashboard.