View a markdown version of this page

Incorporación de Amazon Q en la experiencia de preguntas frecuentes generativas de Amazon Quick Sight & - Amazon Quick

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Incorporación de Amazon Q en la experiencia de preguntas frecuentes generativas de Amazon Quick Sight &

   Público objetivo: desarrolladores de Amazon Quick 

En las siguientes secciones, encontrará información detallada sobre cómo configurar una experiencia de preguntas y respuestas generativas incrustada que use capacidades de NLQ mejoradas impulsadas por los LLM. La experiencia de preguntas y respuestas generativas es el sustituto recomendado de la barra de búsqueda Q incrustada y proporciona a los usuarios una experiencia de BI actualizada.

Incorporación de Amazon Q en Amazon Quick Sight Generative Q: & una experiencia para usuarios registrados

En las siguientes secciones, encontrará información detallada sobre cómo configurar una experiencia de preguntas y respuestas generativas integrada para los usuarios registrados de Amazon Quick Sight.

Paso 1: configuración de permisos

En la siguiente sección, encontrará información sobre cómo configurar los permisos de la aplicación de backend o del servidor web para incrustar la experiencia de preguntas y respuestas generativas. Esta tarea requiere acceso administrativo a AWS Identity and Access Management (IAM).

Cada usuario que accede a una experiencia de preguntas y respuestas generativas asume una función que le otorga acceso y permisos a Amazon Quick Sight. Para ello, cree un rol de IAM en su Cuenta de AWS. Asocie una política de IAM al rol para proporcionar permisos a cualquier usuario que lo asuma. El rol de IAM debe proporcionar permisos para recuperar las URL integradas para un grupo de usuarios específico.

Con la ayuda del carácter comodín *, puede conceder los permisos necesarios para generar una URL para todos los usuarios de un espacio de nombres específico. También puede conceder permisos para generar una URL para un subconjunto de usuarios en espacios de nombres específicos. Para ello, añada quicksight:GenerateEmbedUrlForRegisteredUser.

Puede crear una condición en su política de IAM que limite los dominios que los desarrolladores pueden incluir en el parámetro AllowedDomains de una operación de la API GenerateEmbedUrlForRegisteredUser. El parámetro AllowedDomains es opcional. Ofrece a los desarrolladores la opción de anular los dominios estáticos configurados en el menú Administrar Amazon Quick Sight y, en su lugar, incluir hasta tres dominios o subdominios que pueden acceder a una URL generada. A continuación, esta URL se integra en el sitio web del desarrollador. Solo los dominios que aparecen en el parámetro pueden acceder a la experiencia de preguntas y respuestas generativas. Sin esta condición, los desarrolladores pueden incluir cualquier dominio de Internet en el parámetro AllowedDomains.

Para limitar los dominios que los desarrolladores pueden usar con este parámetro, añada una condición AllowedEmbeddingDomains a su política de IAM. Para obtener más información sobre el AllowedDomains parámetro, consulte la referencia de GenerateEmbedUrlForRegisteredUser la API de Amazon Quick Sight.

Mejores prácticas de seguridad para los operadores de condiciones de IAM

Los operadores de condiciones de IAM mal configurados pueden permitir el acceso no autorizado a los recursos rápidos incrustados mediante variaciones de URL. Cuando utilices la clave de quicksight:AllowedEmbeddingDomains condición en tus políticas de IAM, utiliza operadores de condiciones que permitan dominios específicos o rechacen todos los dominios que no estén específicamente permitidos. Para obtener más información sobre los operadores de condiciones de IAM, consulte Elementos de la política JSON de IAM: operadores de condiciones en la Guía del usuario de IAM.

Muchas variaciones de URL diferentes pueden apuntar al mismo recurso. Por ejemplo, todas las siguientes URL tienen como resultado el mismo contenido:

  • https://example.com

  • https://example.com/

  • https://Example.com

Si su política utiliza operadores que no tienen en cuenta estas variaciones de URL, un atacante puede eludir sus restricciones proporcionando variaciones de URL equivalentes.

Debes comprobar que tu política de IAM utiliza los operadores de condiciones adecuados para evitar eludir las vulnerabilidades y garantizar que solo los dominios a los que están destinados puedan acceder a los recursos integrados.

La siguiente política de ejemplo ofrece estos permisos.

Además, si va a crear usuarios nuevos que van a leer Amazon Quick Sight, asegúrese de añadir el quicksight:RegisterUser permiso en la política.

El siguiente ejemplo de política otorga permiso para recuperar una URL incrustada para los usuarios primerizos que van a leer Amazon Quick Sight.

Finalmente, la identidad de IAM de su aplicación debe tener asociada una política de confianza para permitir el acceso al rol que acaba de crear. Esto significa que cuando un usuario accede a su aplicación, esta puede asumir la función en nombre del usuario y aprovisionar al usuario en Amazon Quick Sight.

En el siguiente ejemplo, se muestra una muestra de política de confianza.

JSON
{ "Version":"2012-10-17", "Statement": [ { "Sid": "AllowLambdaFunctionsToAssumeThisRole", "Effect": "Allow", "Principal": { "Service": "lambda.amazonaws.com" }, "Action": "sts:AssumeRole" }, { "Sid": "AllowEC2InstancesToAssumeThisRole", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }

Para obtener más información sobre las políticas de confianza para la autenticación de OpenID Connect o lenguaje de marcado para confirmaciones de seguridad (SAML), consulte las siguientes secciones de la Guía de usuario de IAM:

Paso 2: generación de la URL con el código de autenticación adjunto

En la siguiente sección, encontrará cómo autenticar a su usuario y obtener la URL del tema de Q integrable en su servidor de aplicaciones. Si tiene previsto incorporar la experiencia de preguntas y respuestas generativas para los tipos de identidad de IAM o Amazon Quick Sight, comparta el tema de la pregunta con los usuarios.

Cuando un usuario accede a su aplicación, esta asume el rol de IAM en nombre del usuario. A continuación, la aplicación agrega al usuario a Amazon Quick Sight, si ese usuario aún no existe. A continuación, transfiere un identificador como ID de sesión de rol único.

Al seguir los pasos descritos, se garantiza que cada usuario que vea el tema Q reciba un aprovisionamiento exclusivo en Amazon Quick Sight. También aplica la configuración por usuario, como la seguridad a nivel de fila y los valores dinámicos predeterminados de los parámetros. Tag-based La seguridad a nivel de fila se puede utilizar para incrustar la barra Q por parte de usuarios anónimos.

Los siguientes ejemplos realizan la autenticación de IAM en nombre del usuario. Este código se ejecuta en el servidor de aplicaciones.

import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.BasicAWSCredentials; import com.amazonaws.auth.AWSCredentialsProvider; import com.amazonaws.regions.Regions; import com.amazonaws.services.quicksight.AmazonQuickSight; import com.amazonaws.services.quicksight.AmazonQuickSightClientBuilder; import com.amazonaws.services.quicksight.model.GenerateEmbedUrlForRegisteredUserRequest; import com.amazonaws.services.quicksight.model.GenerateEmbedUrlForRegisteredUserResult; import com.amazonaws.services.quicksight.model.RegisteredUserEmbeddingExperienceConfiguration; import com.amazonaws.services.quicksight.model.RegisteredUserGenerativeQnAEmbeddingConfiguration; /** * Class to call QuickSight AWS SDK to get url for embedding Generative Q&A experience. */ public class RegisteredUserGenerativeQnAEmbeddingSample { private final AmazonQuickSight quickSightClient; public RegisteredUserGenerativeQnAEmbeddingSample() { this.quickSightClient = AmazonQuickSightClientBuilder .standard() .withRegion(Regions.US_EAST_1.getName()) .withCredentials(new AWS CredentialsProvider() { @Override public AWSCredentials getCredentials() { // provide actual IAM access key and secret key here return new BasicAWSCredentials("access-key", "secret-key"); } @Override public void refresh() { } } ) .build(); } public String getQuicksightEmbedUrl( final String accountId, // AWS Account ID final String topicId, // Topic ID to embed final List<String> allowedDomains, // Runtime allowed domain for embedding final String userArn // Registered user arn to use for embedding. Refer to Get Embed Url section in developer portal to find how to get user arn for a QuickSight user. ) throws Exception { final RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration = new RegisteredUserEmbeddingExperienceConfiguration() .withGenerativeQnA(new RegisteredUserGenerativeQnAEmbeddingConfiguration().withInitialTopicId(topicId)); final GenerateEmbedUrlForRegisteredUserRequest generateEmbedUrlForRegisteredUserRequest = new GenerateEmbedUrlForRegisteredUserRequest(); generateEmbedUrlForRegisteredUserRequest.setAwsAccountId(accountId); generateEmbedUrlForRegisteredUserRequest.setUserArn(userArn); generateEmbedUrlForRegisteredUserRequest.setAllowedDomains(allowedDomains); generateEmbedUrlForRegisteredUserRequest.setExperienceConfiguration(experienceConfiguration); final GenerateEmbedUrlForRegisteredUserResult generateEmbedUrlForRegisteredUserResult = quickSightClient.generateEmbedUrlForRegisteredUser(generateEmbedUrlForRegisteredUserRequest); return generateEmbedUrlForRegisteredUserResult.getEmbedUrl(); } }
nota

Los navegadores no pueden llamar directamente a las API de generación de URL incrustadas. En su lugar, consulte el ejemplo Node.JS .

import json import boto3 from botocore.exceptions import ClientError sts = boto3.client('sts') # Function to generate embedded URL # accountId: AWS account ID # topicId: Topic ID to embed # userArn: arn of registered user # allowedDomains: Runtime allowed domain for embedding # roleArn: IAM user role to use for embedding # sessionName: session name for the roleArn assume role def getEmbeddingURL(accountId, topicId, userArn, allowedDomains, roleArn, sessionName): try: assumedRole = sts.assume_role( RoleArn = roleArn, RoleSessionName = sessionName, ) except ClientError as e: return "Error assuming role: " + str(e) else: assumedRoleSession = boto3.Session( aws_access_key_id = assumedRole['Credentials']['AccessKeyId'], aws_secret_access_key = assumedRole['Credentials']['SecretAccessKey'], aws_session_token = assumedRole['Credentials']['SessionToken'], ) try: quicksightClient = assumedRoleSession.client('quicksight', region_name='us-west-2') response = quicksightClient.generate_embed_url_for_registered_user( AwsAccountId=accountId, ExperienceConfiguration = { 'GenerativeQnA': { 'InitialTopicId': topicId } }, UserArn = userArn, AllowedDomains = allowedDomains, SessionLifetimeInMinutes = 600 ) return { 'statusCode': 200, 'headers': {"Access-Control-Allow-Origin": "*", "Access-Control-Allow-Headers": "Content-Type"}, 'body': json.dumps(response), 'isBase64Encoded': bool('false') } except ClientError as e: return "Error generating embedding url: " + str(e)

El siguiente ejemplo muestra el JavaScript (Node.js) que puede usar en el servidor de aplicaciones para generar la URL del panel integrado. Puede utilizar esta URL en su sitio web o aplicación para mostrar el panel.

ejemplo
const AWS = require('aws-sdk'); const https = require('https'); var quicksightClient = new AWS.Service({ region: 'us-east-1' }); quicksightClient.generateEmbedUrlForRegisteredUser({ 'AwsAccountId': '111122223333', 'ExperienceConfiguration': { 'GenerativeQnA': { 'InitialTopicId': 'U4zJMVZ2n2stZflc8Ou3iKySEb3BEV6f' } }, 'UserArn': 'REGISTERED_USER_ARN', 'AllowedDomains': allowedDomains, 'SessionLifetimeInMinutes': 100 }, function(err, data) { console.log('Errors: '); console.log(err); console.log('Response: '); console.log(data); });

En el siguiente ejemplo se muestra la. NET/C# código que puede usar en el servidor de aplicaciones para generar la URL de la barra de búsqueda Q incrustada. Puede utilizar esta URL en su sitio web o aplicación para mostrar la barra de búsqueda de Q.

ejemplo
using System; using Amazon.QuickSight; using Amazon.QuickSight.Model; namespace GenerateGenerativeQnAEmbedUrlForRegisteredUser { class Program { static void Main(string[] args) { var quicksightClient = new AmazonQuickSightClient( AccessKey, SecretAccessKey, SessionToken, Amazon.RegionEndpoint.USEast1); try { RegisteredUserGenerativeQnAEmbeddingConfiguration registeredUserGenerativeQnAEmbeddingConfiguration = new RegisteredUserGenerativeQnAEmbeddingConfiguration { InitialTopicId = "U4zJMVZ2n2stZflc8Ou3iKySEb3BEV6f" }; RegisteredUserEmbeddingExperienceConfiguration registeredUserEmbeddingExperienceConfiguration = new RegisteredUserEmbeddingExperienceConfiguration { GenerativeQnA = registeredUserGenerativeQnAEmbeddingConfiguration }; Console.WriteLine( quicksightClient.GenerateEmbedUrlForRegisteredUserAsync(new GenerateEmbedUrlForRegisteredUserRequest { AwsAccountId = "111122223333", ExperienceConfiguration = registeredUserEmbeddingExperienceConfiguration, UserArn = "REGISTERED_USER_ARN", AllowedDomains = allowedDomains, SessionLifetimeInMinutes = 100 }).Result.EmbedUrl ); } catch (Exception ex) { Console.WriteLine(ex.Message); } } } }

Para asumir la función, elija una de las siguientes AWS Security Token Service (AWS STS) operaciones de API:

  • AssumeRole— Utilice esta operación cuando utilice una identidad de IAM para asumir el rol.

  • AssumeRoleWithWebIdentity— Utilice esta operación cuando utilice un proveedor de identidad web para autenticar a su usuario.

  • AssumeRoleWithSaml— Utilice esta operación cuando utilice SAML para autenticar a sus usuarios.

En el siguiente ejemplo, se muestra el comando de la CLI para definir el rol de IAM. El rol debe tener los permisos de quicksight:GenerateEmbedUrlForRegisteredUser habilitados. Si adopta un enfoque “justo a tiempo” para añadir usuarios cuando utilizan un tema en la barra de búsqueda de Q, el rol también necesita permisos habilitados para quicksight:RegisterUser.

aws sts assume-role \ --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_q_generative_qna_role" \ --role-session-name john.doe@example.com

La operación assume-role devuelve tres parámetros de salida: la clave de acceso, la clave secreta y el token de sesión.

nota

Si se produce un error ExpiredToken al llamar a la operación AssumeRole, probablemente se debe a que el SESSION TOKEN anterior aún se encuentra en las variables de entorno. Para retirarlo, establezca las variables siguientes:

  • AWS_ACCESS_KEY_ID

  • AWS_SECRET_ACCESS_KEY

  • AWS_SESSION_TOKEN

En el siguiente ejemplo, se muestra cómo definir estos tres parámetros en la CLI. En un ordenador con Microsoft Windows, utilice set en lugar de export.

export AWS_ACCESS_KEY_ID = "access_key_from_assume_role" export AWS_SECRET_ACCESS_KEY = "secret_key_from_assume_role" export AWS_SESSION_TOKEN = "session_token_from_assume_role"

Al ejecutar estos comandos, se define el ID de sesión del rol del usuario que visita su sitio web como embedding_quicksight_q_search_bar_role/john.doe@example.com. El ID de sesión del rol está compuesto por el nombre del rol de role-arn y el valor de role-session-name. Al utilizar el ID de sesión del rol único para cada usuario, se garantiza que se definan los permisos correspondientes para cada usuario. También evitará la limitación del acceso de los usuarios. La limitación es una función de seguridad que impide que un mismo usuario acceda a Amazon Quick Sight desde varias ubicaciones.

El identificador de sesión del rol también se convierte en el nombre de usuario en Amazon Quick Sight. Puede utilizar este patrón para aprovisionar a sus usuarios en Amazon Quick Sight con antelación o para aprovisionarlos la primera vez que accedan a la experiencia de preguntas y respuestas generativas.

En el siguiente ejemplo, se muestra el comando de la CLI que puede utilizar para incluir a un usuario. Para obtener más información RegisterUser y otras operaciones de la API de Amazon Quick Sight, consulte la referencia de la API de Amazon Quick Sight. DescribeUser

aws quicksight register-user \ --aws-account-id 111122223333 \ --namespace default \ --identity-type IAM\ --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_q_generative_qna_role" \ --user-role READER \ --user-name jhnd \ --session-name "john.doe@example.com" \ --email john.doe@example.com \ --region us-east-1 \ --custom-permissions-name TeamA1

Si el usuario se ha autenticado a través de Microsoft AD, no es necesario utilizar RegisterUser para configurarlo. En su lugar, deberían suscribirse automáticamente la primera vez que accedan a Amazon Quick Sight. En el caso de los usuarios de Microsoft AD, puede utilizar DescribeUser para obtener el Nombre de recurso de Amazon (ARN) del usuario.

La primera vez que un usuario accede a Amazon Quick Sight, también puede añadirlo al grupo con el que se comparte el panel de control. En el siguiente ejemplo, se muestra el comando de la CLI para añadir un usuario a un grupo.

aws quicksight create-group-membership \ --aws-account-id 111122223333 \ --namespace default \ --group-name financeusers \ --member-name "embedding_quicksight_q_generative_qna_role/john.doe@example.com"

Ahora tiene un usuario de su aplicación que también es usuario de Amazon Quick Sight y que tiene acceso al panel de control.

Por último, para obtener una URL firmada para el panel, llame a generate-embed-url-for-registered-user desde el servidor de aplicaciones. Esta operación devuelve la URL del panel integrable. En el siguiente ejemplo, se muestra cómo generar la URL de un panel integrado mediante una llamada desde el servidor para los usuarios autenticados mediante un inicio de sesión único AWS Managed Microsoft AD o mediante un inicio de sesión único (IAM Identity Center).

aws quicksight generate-embed-url-for-anonymous-user \ --aws-account-id 111122223333 \ --namespace default-or-something-else \ --authorized-resource-arns '["topic-arn-topicId1","topic-arn-topicId2"]' \ --allowed-domains '["domain1","domain2"]' \ --experience-configuration 'GenerativeQnA={InitialTopicId="topicId1"}' \ --session-tags '["Key": tag-key-1,"Value": tag-value-1,{"Key": tag-key-1,"Value": tag-value-1}]' \ --session-lifetime-in-minutes 15

Para obtener más información sobre cómo usar esta operación, consulte GenerateEmbedUrlForRegisteredUser. Puede utilizar esta y otras operaciones de la API en su propio código.

Paso 3: Inserte la URL de la experiencia Generative Q A &amp;

En la siguiente sección, encontrará información sobre cómo incrustar la URL de la experiencia de preguntas y respuestas generativas en su sitio web o página de la aplicación. Esto se hace con el SDK de incrustación de Amazon Quick Sight (). JavaScript Con el SDK, puede hacer lo siguiente:

  • Colocar la experiencia de preguntas y respuestas generativas en una página HTML.

  • Personalizar el diseño y la apariencia de la experiencia incrustada para adaptarla a las necesidades de su aplicación.

  • Resolver los estados de error con mensajes que se personalizan en su aplicación.

Llame a la operación de la API GenerateEmbedUrlForRegisteredUser para generar la dirección URL que puede integrar en la aplicación. Esta URL es válida durante 5 minutos, y la sesión resultante es válida hasta 10 horas. La operación de la API proporciona la URL con un valor auth_code que permite una sesión con inicio único.

El siguiente es un ejemplo de respuesta de generate-embed-url-for-registered-user.

//The URL returned is over 900 characters. For this example, we've shortened the string for //readability and added ellipsis to indicate that it's incomplete. { "Status": "200", "EmbedUrl": "https://quicksightdomain/embedding/12345/q/search...", "RequestId": "7bee030e-f191-45c4-97fe-d9faf0e03713" }

Integre la experiencia de preguntas y respuestas generativas en su página web mediante el SDK de incrustación de Amazon Quick Sight o añadiendo esta URL a un iframe. Si establece un número fijo de altura y anchura (en píxeles), Amazon Quick Sight los utiliza y no cambia el aspecto visual cuando la ventana cambia de tamaño. Si establece un porcentaje relativo de altura y anchura, Amazon Quick Sight proporciona un diseño adaptable que se modifica a medida que cambia el tamaño de la ventana.

Asegúrese de que el dominio que aloja la experiencia integrada de preguntas y respuestas generativas esté en la lista de dominios permitidos, la lista de dominios aprobados para su suscripción a Amazon Quick Sight. Este requisito protege los datos impidiendo que dominios no aprobados alojen paneles integrados. Para obtener más información sobre cómo agregar dominios para la experiencia de preguntas y respuestas generativas incrustada, consulte Administrar dominios.

Puede usar el SDK de incrustación de Amazon Quick Sight para personalizar el diseño y el aspecto de la experiencia de preguntas y respuestas generativas integrada para adaptarla a su aplicación. Use la propiedad panelType para configurar el estado inicial de la experiencia de preguntas y respuestas generativas cuando se muestre en su aplicación. Establezca la propiedad panelType en 'FULL' para que represente el panel completo de la experiencia de preguntas y respuestas generativas. Este panel se parece a la experiencia que tienen los usuarios de Amazon Quick Sight en la consola de Amazon Quick Sight. La altura del marco del panel no cambia en función de la interacción del usuario y respeta el valor establecido en la propiedad frameOptions.height. La siguiente imagen muestra el panel de la experiencia de preguntas y respuestas generativas que se representa cuando se establece el valor panelType en 'FULL'.

Establezca la propiedad panelType en 'SEARCH_BAR' para que represente la experiencia de preguntas y respuestas generativas como una barra de búsqueda. Esta barra de búsqueda se parece a la forma en que se representa la barra de búsqueda de Q cuando está incrustada en una aplicación. La barra de búsqueda preguntas y respuestas generativas se expande hasta convertirse en un panel más grande que muestra las opciones de selección de temas, la lista de sugerencias de preguntas, el panel de respuestas o el tablón de anuncios.

La altura mínima predeterminada de la barra de búsqueda de preguntas y respuestas generativas se representa cuando se carga el recurso incrustado. Se recomienda establecer el valor frameOptions.height en "38px" para optimizar la experiencia de la barra de búsqueda. Use la propiedad focusedHeight para establecer el tamaño óptimo del menú desplegable de selección de temas y de la lista de sugerencias de preguntas. Utilice la propiedad expandedHeight para establecer el tamaño óptimo del panel de respuestas y del tablón de anuncios. Si elige la opción 'SEARCH_BAR', se recomienda diseñar el contenedor principal con una posición (absoluta) para evitar que contenido no deseado se desplace en la aplicación. La siguiente imagen muestra la barra de búsqueda de la experiencia de preguntas y respuestas generativas que se representa cuando se establece el valor panelType en 'SEARCH_BAR'.

Tras configurar la panelType propiedad, utilice el SDK de incrustación de Amazon Quick Sight para personalizar las siguientes propiedades de la experiencia de preguntas y respuestas generativas.

  • El título del panel de preguntas y respuestas generativas (solo se aplica a la opción panelType: FULL).

  • El texto del marcador de posición de la barra de búsqueda.

  • Si se permite la selección de temas.

  • Si se muestran u ocultan los nombres de los temas.

  • Si se muestra u oculta el icono de Amazon Q (solo se aplica a la opción panelType: FULL).

  • Si muestra u oculta el tablón de anuncios.

  • Si los usuarios pueden maximizar el panel de preguntas y respuestas generativas a pantalla completa.

  • El tema del panel de preguntas y respuestas generativas. Se puede pasar un ARN de tema personalizado al SDK para cambiar la apariencia del contenido del marco. Los temas de inicio de Amazon Quick Sight no son compatibles con los paneles de inteligencia empresarial generativa integrados. Para usar un tema de inicio de Amazon Quick Sight, guárdelo como tema personalizado en Amazon Quick Sight.

Cuando utiliza el SDK de incrustación de Amazon Quick Sight, la experiencia generativa de preguntas y respuestas de su página cambia de tamaño de forma dinámica en función del estado. Al utilizar el SDK de incrustación de Amazon Quick Sight, también puede controlar los parámetros de la experiencia de preguntas y respuestas generativas y recibir llamadas en función de la finalización de la carga de la página, los cambios de estado y los errores.

En el siguiente ejemplo, se muestra cómo utilizar la URL generada. Este código se genera en el servidor de aplicaciones.

<!DOCTYPE html> <html> <head> <title>Generative Q&A Embedding Example</title> <script src="https://unpkg.com/amazon-quicksight-embedding-sdk@2.7.0/dist/quicksight-embedding-js-sdk.min.js"></script> <script type="text/javascript"> const embedGenerativeQnA = async() => { const {createEmbeddingContext} = QuickSightEmbedding; const embeddingContext = await createEmbeddingContext({ onChange: (changeEvent, metadata) => { console.log('Context received a change', changeEvent, metadata); }, }); const frameOptions = { url: "<YOUR_EMBED_URL>", // replace this value with the url generated via embedding API container: '#experience-container', height: "700px", width: "1000px", onChange: (changeEvent, metadata) => { switch (changeEvent.eventName) { case 'FRAME_MOUNTED': { console.log("Do something when the experience frame is mounted."); break; } case 'FRAME_LOADED': { console.log("Do something when the experience frame is loaded."); break; } } }, }; const contentOptions = { // Optional panel settings. Default behavior is equivalent to {panelType: 'FULL'} panelOptions: { panelType: 'FULL', title: 'custom title', // Optional showQIcon: false, // Optional, Default: true }, // Use SEARCH_BAR panel type for the landing state to be similar to embedQSearchBar // with generative capability enabled topics /* panelOptions: { panelType: 'SEARCH_BAR', focusedHeight: '250px', expandedHeight: '500px', }, */ showTopicName: false, // Optional, Default: true showPinboard: false, // Optional, Default: true allowTopicSelection: false, // Optional, Default: true allowFullscreen: false, // Optional, Default: true searchPlaceholderText: "custom search placeholder", // Optional themeOptions: { // Optional themeArn: 'arn:aws:quicksight:<Region>:<AWS-Account-ID>:theme/<Theme-ID>' } onMessage: async (messageEvent, experienceMetadata) => { switch (messageEvent.eventName) { case 'Q_SEARCH_OPENED': { // called when pinboard is shown / visuals are rendered console.log("Do something when SEARCH_BAR type panel is expanded"); break; } case 'Q_SEARCH_FOCUSED': { // called when question suggestions or topic selection dropdown are shown console.log("Do something when SEARCH_BAR type panel is focused"); break; } case 'Q_SEARCH_CLOSED': { // called when shrinked to initial bar height console.log("Do something when SEARCH_BAR type panel is collapsed"); break; } case 'Q_PANEL_ENTERED_FULLSCREEN': { console.log("Do something when panel enters full screen mode"); break; } case 'Q_PANEL_EXITED_FULLSCREEN': { console.log("Do something when panel exits full screen mode"); break; } case 'CONTENT_LOADED': { console.log("Do something after experience is loaded"); break; } case 'ERROR_OCCURRED': { console.log("Do something when experience fails to load"); break; } } } }; const embeddedGenerativeQnExperience = await embeddingContext.embedGenerativeQnA(frameOptions, contentOptions); }; </script> </head> <body onload="embedGenerativeQnA()"> <div id="experience-container"></div> </body> </html>

Para que este ejemplo funcione, asegúrese de utilizar el SDK de incrustación de Amazon Quick Sight para cargar la experiencia de preguntas y respuestas generativas integrada en su sitio web. JavaScript Para obtener su copia, siga uno de estos pasos:

Funcionalidades integradas opcionales de Generative Q &amp; A Experience

A continuación se detallan las funcionalidades opcionales que están disponibles para la experiencia de preguntas y respuestas generativas con el SDK de incrustación.

Invoque las acciones de Generative Q A en la barra &amp; de búsqueda

  • Establecer una pregunta: esta característica envía una pregunta a la experiencia de preguntas y respuestas generativas y consulta la pregunta de inmediato.

    embeddedGenerativeQnExperience.setQuestion('show me monthly revenue');
  • Cerrar el panel de respuestas (se aplica a la opción de la barra de búsqueda preguntas y respuestas generativas): esta característica cierra el panel de respuestas y devuelve el iframe al estado original de la barra de búsqueda.

    embeddedGenerativeQnExperience.close();

Para obtener más información, consulte el SDK de incrustación de Amazon Quick Sight.

Incrustar Amazon Q en Quick Generative Q: &amp; una experiencia para usuarios anónimos (no registrados)

   Público objetivo: desarrolladores de Amazon Quick 

En las secciones siguientes, encontrará información detallada sobre cómo configurar una experiencia de preguntas y respuestas generativas incrustada para usuarios anónimos (no registrados).

Paso 1: configuración de permisos

En la siguiente sección, encontrará información sobre cómo configurar los permisos de la aplicación de backend o del servidor web para incrustar la experiencia de preguntas y respuestas generativas. Esta tarea requiere acceso administrativo a AWS Identity and Access Management (IAM).

Cada usuario que accede a una experiencia de preguntas y respuestas generativas asume una función que le otorga acceso y permisos a Amazon Quick Sight. Para ello, cree un rol de IAM en su Cuenta de AWS. Asocie una política de IAM al rol para proporcionar permisos a cualquier usuario que lo asuma. El rol de IAM debe proporcionar permisos para recuperar las URL integradas para un grupo de usuarios específico.

Con la ayuda del carácter comodín *, puede conceder los permisos necesarios para generar una URL para todos los usuarios de un espacio de nombres específico. También puede conceder permisos para generar una URL para un subconjunto de usuarios en espacios de nombres específicos. Para ello, añada quicksight:GenerateEmbedUrlForAnonymousUser.

Puede crear una condición en su política de IAM que limite los dominios que los desarrolladores pueden incluir en el parámetro AllowedDomains de una operación de la API GenerateEmbedUrlForAnonymousUser. El parámetro AllowedDomains es opcional. Ofrece a los desarrolladores la opción de anular los dominios estáticos configurados en el menú Administrar Amazon Quick Sight y, en su lugar, incluir hasta tres dominios o subdominios que pueden acceder a una URL generada. A continuación, esta URL se integra en el sitio web del desarrollador. Solo los dominios que aparecen en el parámetro pueden acceder a la barra de búsqueda de Q. Sin esta condición, los desarrolladores pueden incluir cualquier dominio de Internet en el parámetro AllowedDomains.

Para limitar los dominios que los desarrolladores pueden usar con este parámetro, añada una condición AllowedEmbeddingDomains a su política de IAM. Para obtener más información sobre el AllowedDomains parámetro, consulte la referencia de GenerateEmbedUrlForAnonymousUser la API de Amazon Quick Sight.

Mejores prácticas de seguridad para los operadores de condiciones de IAM

Los operadores de condiciones de IAM mal configurados pueden permitir el acceso no autorizado a los recursos rápidos incrustados mediante variaciones de URL. Cuando utilices la clave de quicksight:AllowedEmbeddingDomains condición en tus políticas de IAM, utiliza operadores de condiciones que permitan dominios específicos o rechacen todos los dominios que no estén específicamente permitidos. Para obtener más información sobre los operadores de condiciones de IAM, consulte Elementos de la política JSON de IAM: operadores de condiciones en la Guía del usuario de IAM.

Muchas variaciones de URL diferentes pueden apuntar al mismo recurso. Por ejemplo, todas las siguientes URL tienen como resultado el mismo contenido:

  • https://example.com

  • https://example.com/

  • https://Example.com

Si su política utiliza operadores que no tienen en cuenta estas variaciones de URL, un atacante puede eludir sus restricciones proporcionando variaciones de URL equivalentes.

Debes comprobar que tu política de IAM utiliza los operadores de condiciones adecuados para evitar eludir las vulnerabilidades y garantizar que solo los dominios a los que están destinados puedan acceder a los recursos integrados.

La identidad de IAM de su aplicación debe tener asociada una política de confianza para permitir el acceso al rol que acaba de crear. Esto significa que, cuando un usuario accede a su aplicación, esta puede asumir el rol en nombre del usuario para cargar la experiencia de preguntas y respuestas generativas. En el siguiente ejemplo, se muestra una muestra de política de confianza.

JSON
{ "Version":"2012-10-17", "Statement": [ { "Sid": "AllowLambdaFunctionsToAssumeThisRole", "Effect": "Allow", "Principal": { "Service": "lambda.amazonaws.com" }, "Action": "sts:AssumeRole" }, { "Sid": "AllowEC2InstancesToAssumeThisRole", "Effect": "Allow", "Principal": { "Service": "ec2.amazonaws.com" }, "Action": "sts:AssumeRole" } ] }

Para obtener más información sobre las políticas de confianza, consulte Credenciales de seguridad temporales en IAM en la Guía del usuario de IAM

Paso 2: generación de la URL con el código de autenticación adjunto

En la siguiente sección, encontrará cómo autenticar a su usuario y obtener la URL del tema de Q integrable en su servidor de aplicaciones.

Cuando un usuario accede a su aplicación, esta asume el rol de IAM en nombre del usuario. A continuación, la aplicación agrega al usuario a Amazon Quick Sight, si ese usuario aún no existe. A continuación, transfiere un identificador como ID de sesión de rol único.

import java.util.List; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AWSCredentialsProvider; import com.amazonaws.auth.BasicAWSCredentials; import com.amazonaws.regions.Regions; import com.amazonaws.services.quicksight.AmazonQuickSight; import com.amazonaws.services.quicksight.AmazonQuickSightClientBuilder; import com.amazonaws.services.quicksight.model.AnonymousUserGenerativeQnAEmbeddingConfiguration; import com.amazonaws.services.quicksight.model.AnonymousUserEmbeddingExperienceConfiguration; import com.amazonaws.services.quicksight.model.GenerateEmbedUrlForAnonymousUserRequest; import com.amazonaws.services.quicksight.model.GenerateEmbedUrlForAnonymousUserResult; import com.amazonaws.services.quicksight.model.SessionTag; /** * Class to call QuickSight AWS SDK to generate embed url for anonymous user. */ public class GenerateEmbedUrlForAnonymousUserExample { private final AmazonQuickSight quickSightClient; public GenerateEmbedUrlForAnonymousUserExample() { quickSightClient = AmazonQuickSightClientBuilder .standard() .withRegion(Regions.US_EAST_1.getName()) .withCredentials(new AWSCredentialsProvider() { @Override public AWSCredentials getCredentials() { // provide actual IAM access key and secret key here return new BasicAWSCredentials("access-key", "secret-key"); } @Override public void refresh() { } } ) .build(); } public String GenerateEmbedUrlForAnonymousUser( final String accountId, // YOUR AWS ACCOUNT ID final String initialTopicId, // Q TOPIC ID TO WHICH THE CONSTRUCTED URL POINTS AND EXPERIENCE PREPOPULATES INITIALLY final String namespace, // ANONYMOUS EMBEDDING REQUIRES SPECIFYING A VALID NAMESPACE FOR WHICH YOU WANT THE EMBEDDING URL final List<String> authorizedResourceArns, // Q TOPIC ARN LIST TO EMBED final List<String> allowedDomains, // RUNTIME ALLOWED DOMAINS FOR EMBEDDING final List<SessionTag> sessionTags // SESSION TAGS USED FOR ROW-LEVEL SECURITY ) throws Exception { AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration = new AnonymousUserEmbeddingExperienceConfiguration(); AnonymousUserGenerativeQnAEmbeddingConfiguration generativeQnAConfiguration = new AnonymousUserGenerativeQnAEmbeddingConfiguration(); generativeQnAConfiguration.setInitialTopicId(initialTopicId); experienceConfiguration.setGenerativeQnA(generativeQnAConfiguration); GenerateEmbedUrlForAnonymousUserRequest generateEmbedUrlForAnonymousUserRequest = new GenerateEmbedUrlForAnonymousUserRequest() .withAwsAccountId(accountId) .withNamespace(namespace) .withAuthorizedResourceArns(authorizedResourceArns) .withExperienceConfiguration(experienceConfiguration) .withSessionTags(sessionTags) .withSessionLifetimeInMinutes(600L); // OPTIONAL: VALUE CAN BE [15-600]. DEFAULT: 600 .withAllowedDomains(allowedDomains); GenerateEmbedUrlForAnonymousUserResult result = quickSightClient.generateEmbedUrlForAnonymousUser(generateEmbedUrlForAnonymousUserRequest); return result.getEmbedUrl(); } }
nota

Los navegadores no pueden llamar directamente a las API de generación de URL incrustadas. En su lugar, consulte el Node.JS ejemplo.

import json import boto3 from botocore.exceptions import ClientError import time # Create QuickSight and STS clients quicksightClient = boto3.client('quicksight',region_name='us-west-2') sts = boto3.client('sts') # Function to generate embedded URL for anonymous user # accountId: YOUR AWS ACCOUNT ID # topicId: Topic ID to embed # quicksightNamespace: VALID NAMESPACE WHERE YOU WANT TO DO NOAUTH EMBEDDING # authorizedResourceArns: TOPIC ARN LIST TO EMBED # allowedDomains: RUNTIME ALLOWED DOMAINS FOR EMBEDDING # sessionTags: SESSION TAGS USED FOR ROW-LEVEL SECURITY def generateEmbedUrlForAnonymousUser(accountId, quicksightNamespace, authorizedResourceArns, allowedDomains, sessionTags): try: response = quicksightClient.generate_embed_url_for_anonymous_user( AwsAccountId = accountId, Namespace = quicksightNamespace, AuthorizedResourceArns = authorizedResourceArns, AllowedDomains = allowedDomains, ExperienceConfiguration = { 'GenerativeQnA': { 'InitialTopicId': topicId } }, SessionTags = sessionTags, SessionLifetimeInMinutes = 600 ) return { 'statusCode': 200, 'headers': {"Access-Control-Allow-Origin": "*", "Access-Control-Allow-Headers": "Content-Type"}, 'body': json.dumps(response), 'isBase64Encoded': bool('false') } except ClientError as e: print(e) return "Error generating embeddedURL: " + str(e)

El siguiente ejemplo muestra el JavaScript (Node.js) que puede usar en el servidor de aplicaciones para generar la URL del panel integrado. Puede utilizar esta URL en su sitio web o aplicación para mostrar el panel.

ejemplo
const AWS = require('aws-sdk'); const https = require('https'); var quicksightClient = new AWS.Service({ region: 'us-east-1', }); quicksightClient.generateEmbedUrlForAnonymousUser({ 'AwsAccountId': '111122223333', 'Namespace': 'DEFAULT' 'AuthorizedResourceArns': '["topic-arn-topicId1","topic-arn-topicId2"]', 'AllowedDomains': allowedDomains, 'ExperienceConfiguration': { 'GenerativeQnA': { 'InitialTopicId': 'U4zJMVZ2n2stZflc8Ou3iKySEb3BEV6f' } }, 'SessionTags': '["Key": tag-key-1,"Value": tag-value-1,{"Key": tag-key-1,"Value": tag-value-1}]', 'SessionLifetimeInMinutes': 15 }, function(err, data) { console.log('Errors: '); console.log(err); console.log('Response: '); console.log(data); });

En el siguiente ejemplo se muestra la. NET/C# código que puede usar en el servidor de aplicaciones para generar la URL de la barra de búsqueda Q incrustada. Puede utilizar esta URL en su sitio web o aplicación para mostrar la barra de búsqueda de Q.

ejemplo
using System; using Amazon.QuickSight; using Amazon.QuickSight.Model; namespace GenerateGenerativeQnAEmbedUrlForAnonymousUser { class Program { static void Main(string[] args) { var quicksightClient = new AmazonQuickSightClient( AccessKey, SecretAccessKey, SessionToken, Amazon.RegionEndpoint.USEast1); try { AnonymousUserGenerativeQnAEmbeddingConfiguration anonymousUserGenerativeQnAEmbeddingConfiguration = new AnonymousUserGenerativeQnAEmbeddingConfiguration { InitialTopicId = "U4zJMVZ2n2stZflc8Ou3iKySEb3BEV6f" }; AnonymousUserEmbeddingExperienceConfiguration anonymousUserEmbeddingExperienceConfiguration = new AnonymousUserEmbeddingExperienceConfiguration { GenerativeQnA = anonymousUserGenerativeQnAEmbeddingConfiguration }; Console.WriteLine( quicksightClient.GenerateEmbedUrlForAnonymousUserAsync(new GenerateEmbedUrlForAnonymousUserRequest { AwsAccountId = "111122223333", Namespace = "DEFAULT", AuthorizedResourceArns '["topic-arn-topicId1","topic-arn-topicId2"]', AllowedDomains = allowedDomains, ExperienceConfiguration = anonymousUserEmbeddingExperienceConfiguration, SessionTags = '["Key": tag-key-1,"Value": tag-value-1,{"Key": tag-key-1,"Value": tag-value-1}]', SessionLifetimeInMinutes = 15, }).Result.EmbedUrl ); } catch (Exception ex) { Console.WriteLine(ex.Message); } } } }

Para asumir la función, elija una de las siguientes AWS Security Token Service (AWS STS) operaciones de API:

  • AssumeRole— Utilice esta operación cuando utilice una identidad de IAM para asumir el rol.

  • AssumeRoleWithWebIdentity— Utilice esta operación cuando utilice un proveedor de identidad web para autenticar a su usuario.

  • AssumeRoleWithSaml— Utilice esta operación cuando utilice SAML para autenticar a sus usuarios.

En el siguiente ejemplo, se muestra el comando de la CLI para definir el rol de IAM. El rol debe tener los permisos de quicksight:GenerateEmbedUrlForAnonymousUser habilitados.

aws sts assume-role \ --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_generative_qna_role" \ --role-session-name anonymous caller

La operación assume-role devuelve tres parámetros de salida: la clave de acceso, la clave secreta y el token de sesión.

nota

Si se produce un error ExpiredToken al llamar a la operación AssumeRole, probablemente se debe a que el SESSION TOKEN anterior aún se encuentra en las variables de entorno. Para retirarlo, establezca las variables siguientes:

  • AWS_ACCESS_KEY_ID

  • AWS_SECRET_ACCESS_KEY

  • AWS_SESSION_TOKEN

En el siguiente ejemplo, se muestra cómo definir estos tres parámetros en la CLI. En un ordenador con Microsoft Windows, utilice set en lugar de export.

export AWS_ACCESS_KEY_ID = "access_key_from_assume_role" export AWS_SECRET_ACCESS_KEY = "secret_key_from_assume_role" export AWS_SESSION_TOKEN = "session_token_from_assume_role"

Al ejecutar estos comandos, se define el ID de sesión del rol del usuario que visita su sitio web como embedding_quicksight_q_search_bar_role/QuickSightEmbeddingAnonymousPolicy. El ID de sesión del rol está compuesto por el nombre del rol de role-arn y el valor de role-session-name. Al utilizar el ID de sesión del rol único para cada usuario, se garantiza que se definan los permisos correspondientes para cada usuario. También evitará la limitación del acceso de los usuarios. La limitación es una función de seguridad que impide que un mismo usuario acceda a Amazon Quick Sight desde varias ubicaciones. Además, mantiene cada sesión separada y distinta. Si utiliza una serie de servidores web, por ejemplo, para equilibrar la carga, y una sesión se vuelve a conectar a un servidor diferente, se inicia una nueva sesión.

Para obtener una URL firmada para el panel, llame a generate-embed-url-for-anynymous-user desde el servidor de aplicaciones. Esta operación devuelve la URL del panel integrable. En el siguiente ejemplo, se muestra cómo generar la URL de un panel integrado mediante una llamada desde el servidor para los usuarios que realizan visitas anónimas a su portal web o aplicación.

aws quicksight generate-embed-url-for-anonymous-user \ --aws-account-id 111122223333 \ --namespace default-or-something-else \ --authorized-resource-arns '["topic-arn-topicId","topic-arn-topicId2"]' \ --allowed-domains '["domain1","domain2"]' \ --experience-configuration 'GenerativeQnA={InitialTopicId="topicId1"}' \ --session-tags '["Key": tag-key-1,"Value": tag-value-1,{"Key": tag-key-1,"Value": tag-value-1}]' \ --session-lifetime-in-minutes 15

Para obtener más información sobre cómo usar esta operación, consulte GenerateEmbedUrlForAnonymousUser. Puede utilizar esta y otras operaciones de la API en su propio código.

Paso 3: Inserte la URL de la experiencia Generative Q A &amp;

En la siguiente sección, encontrará información sobre cómo incrustar la URL de la experiencia de preguntas y respuestas generativas en su sitio web o página de la aplicación. Esto se hace con el SDK de incrustación de Amazon Quick Sight (). JavaScript Con el SDK, puede hacer lo siguiente:

  • Colocar la experiencia de preguntas y respuestas generativas en una página HTML.

  • Personalizar el diseño y la apariencia de la experiencia incrustada para adaptarla a las necesidades de su aplicación.

  • Resolver los estados de error con mensajes que se personalizan en su aplicación.

Llame a la operación de la API GenerateEmbedUrlForAnonymousUser para generar la dirección URL que puede integrar en la aplicación. Esta URL es válida durante 5 minutos, y la sesión resultante es válida hasta 10 horas. La operación de la API proporciona la URL con un valor auth_code que permite una sesión con inicio único.

El siguiente es un ejemplo de respuesta de generate-embed-url-for-anonymous-user.

//The URL returned is over 900 characters. For this example, we've shortened the string for //readability and added ellipsis to indicate that it's incomplete.{ "Status": "200", "EmbedUrl": "https://quicksightdomain/embedding/12345/q/search...", "RequestId": "7bee030e-f191-45c4-97fe-d9faf0e03713" }

Integre la experiencia de preguntas y respuestas generativas en su página web con el SDK de incrustación de Amazon Quick Sight o añadiendo esta URL a un iframe. Si establece un número fijo de altura y anchura (en píxeles), Amazon Quick Sight los utiliza y no cambia el aspecto visual cuando la ventana cambia de tamaño. Si establece un porcentaje relativo de altura y anchura, Amazon Quick Sight proporciona un diseño adaptable que se modifica a medida que cambia el tamaño de la ventana.

Asegúrese de que el dominio en el que se alojará la experiencia de preguntas y respuestas generativas esté en la lista de dominios permitidos, la lista de dominios aprobados para su suscripción a Amazon Quick Sight. Este requisito protege los datos al impedir que dominios no aprobados alojen experiencias de preguntas y respuestas generativas incrustadas. Para obtener más información sobre cómo agregar dominios para la experiencia de preguntas y respuestas generativas incrustada, consulte Administrar dominios.

Puede usar el SDK de incrustación de Amazon Quick Sight para personalizar el diseño y el aspecto de la experiencia de preguntas y respuestas generativas integrada y adaptarla a su aplicación. Use la propiedad panelType para configurar el estado inicial de la experiencia de preguntas y respuestas generativas cuando se muestre en su aplicación. Establezca la propiedad panelType en 'FULL' para que represente el panel completo de la experiencia de preguntas y respuestas generativas. Este panel se parece a la experiencia que tienen los usuarios de Amazon Quick Sight en la consola de Amazon Quick Sight. La altura del marco del panel no cambia en función de la interacción del usuario y respeta el valor establecido en la propiedad frameOptions.height. La siguiente imagen muestra el panel de la experiencia de preguntas y respuestas generativas que se representa cuando se establece el valor panelType en 'FULL'.

Establezca la propiedad panelType en 'SEARCH_BAR' para que represente la experiencia de preguntas y respuestas generativas como una barra de búsqueda. Esta barra de búsqueda se parece a la forma en que se representa la barra de búsqueda de Q cuando está incrustada en una aplicación. La barra de búsqueda preguntas y respuestas generativas se expande hasta convertirse en un panel más grande que muestra las opciones de selección de temas, la lista de sugerencias de preguntas, el panel de respuestas o el tablón de anuncios.

La altura mínima predeterminada de la barra de búsqueda de preguntas y respuestas generativas se representa cuando se carga el recurso incrustado. Se recomienda establecer el valor frameOptions.height en "38px" para optimizar la experiencia de la barra de búsqueda. Use la propiedad focusedHeight para establecer el tamaño óptimo del menú desplegable de selección de temas y de la lista de sugerencias de preguntas. Utilice la propiedad expandedHeight para establecer el tamaño óptimo del panel de respuestas y del tablón de anuncios. Si elige la opción 'SEARCH_BAR', se recomienda diseñar el contenedor principal con una posición (absoluta) para evitar que contenido no deseado se desplace en la aplicación. La siguiente imagen muestra la barra de búsqueda de la experiencia de preguntas y respuestas generativas que se representa cuando se establece el valor panelType en 'SEARCH_BAR'.

Tras configurar la panelType propiedad, utilice el SDK de incrustación de Amazon Quick Sight para personalizar las siguientes propiedades de la experiencia de preguntas y respuestas generativas.

  • El título del panel de preguntas y respuestas generativas (solo se aplica a la opción panelType: FULL).

  • El texto del marcador de posición de la barra de búsqueda.

  • Si se permite la selección de temas.

  • Si se muestran u ocultan los nombres de los temas.

  • Si se muestra u oculta el icono de Amazon Q (solo se aplica a la opción panelType: FULL).

  • Si muestra u oculta el tablón de anuncios.

  • Si los usuarios pueden maximizar el panel de preguntas y respuestas generativas a pantalla completa.

  • El tema del panel de preguntas y respuestas generativas. Se puede pasar un ARN de tema personalizado al SDK para cambiar la apariencia del contenido del marco. Los temas de inicio de Amazon Quick Sight no son compatibles con los paneles de inteligencia empresarial generativa integrados. Para usar un tema de inicio de Amazon Quick Sight, guárdelo como tema personalizado en Amazon Quick Sight.

Cuando utiliza el SDK de incrustación de Amazon Quick Sight, la experiencia generativa de preguntas y respuestas de su página cambia de tamaño de forma dinámica en función del estado. Con el SDK de incrustación de Amazon Quick Sight, también puede controlar los parámetros de la experiencia de preguntas y respuestas generativas y recibir llamadas en función de la finalización de la carga de la página, los cambios de estado y los errores.

En el siguiente ejemplo, se muestra cómo utilizar la URL generada. Este código se genera en el servidor de aplicaciones.

<!DOCTYPE html> <html> <head> <title>Generative Q&A Embedding Example</title> <script src="https://unpkg.com/amazon-quicksight-embedding-sdk@2.7.0/dist/quicksight-embedding-js-sdk.min.js"></script> <script type="text/javascript"> const embedGenerativeQnA = async() => { const {createEmbeddingContext} = QuickSightEmbedding; const embeddingContext = await createEmbeddingContext({ onChange: (changeEvent, metadata) => { console.log('Context received a change', changeEvent, metadata); }, }); const frameOptions = { url: "<YOUR_EMBED_URL>", // replace this value with the url generated via embedding API container: '#experience-container', height: "700px", width: "1000px", onChange: (changeEvent, metadata) => { switch (changeEvent.eventName) { case 'FRAME_MOUNTED': { console.log("Do something when the experience frame is mounted."); break; } case 'FRAME_LOADED': { console.log("Do something when the experience frame is loaded."); break; } } }, }; const contentOptions = { // Optional panel settings. Default behavior is equivalent to {panelType: 'FULL'} panelOptions: { panelType: 'FULL', title: 'custom title', // Optional showQIcon: false, // Optional, Default: true }, // Use SEARCH_BAR panel type for the landing state to be similar to embedQSearchBar // with generative capability enabled topics /* panelOptions: { panelType: 'SEARCH_BAR', focusedHeight: '250px', expandedHeight: '500px', }, */ showTopicName: false, // Optional, Default: true showPinboard: false, // Optional, Default: true allowTopicSelection: false, // Optional, Default: true allowFullscreen: false, // Optional, Default: true searchPlaceholderText: "custom search placeholder", // Optional themeOptions: { // Optional themeArn: 'arn:aws:quicksight:<Region>:<AWS-Account-ID>:theme/<Theme-ID>' } onMessage: async (messageEvent, experienceMetadata) => { switch (messageEvent.eventName) { case 'Q_SEARCH_OPENED': { // called when pinboard is shown / visuals are rendered console.log("Do something when SEARCH_BAR type panel is expanded"); break; } case 'Q_SEARCH_FOCUSED': { // called when question suggestions or topic selection dropdown are shown console.log("Do something when SEARCH_BAR type panel is focused"); break; } case 'Q_SEARCH_CLOSED': { // called when shrinked to initial bar height console.log("Do something when SEARCH_BAR type panel is collapsed"); break; } case 'Q_PANEL_ENTERED_FULLSCREEN': { console.log("Do something when panel enters full screen mode"); break; } case 'Q_PANEL_EXITED_FULLSCREEN': { console.log("Do something when panel exits full screen mode"); break; } case 'CONTENT_LOADED': { console.log("Do something after experience is loaded"); break; } case 'ERROR_OCCURRED': { console.log("Do something when experience fails to load"); break; } } } }; const embeddedGenerativeQnExperience = await embeddingContext.embedGenerativeQnA(frameOptions, contentOptions); }; </script> </head> <body onload="embedGenerativeQnA()"> <div id="experience-container"></div> </body> </html>

Para que este ejemplo funcione, asegúrese de utilizar el SDK de incrustación de Amazon Quick Sight para cargar la experiencia de preguntas y respuestas generativas integrada en su sitio web. JavaScript Para obtener su copia, siga uno de estos pasos:

Funcionalidades integradas opcionales de Generative Q &amp; A Experience

A continuación se detallan las funcionalidades opcionales que están disponibles para la experiencia de preguntas y respuestas generativas con el SDK de incrustación.

Invoque las acciones de Generative Q A en la barra &amp; de búsqueda

  • Establecer una pregunta: esta característica envía una pregunta a la experiencia de preguntas y respuestas generativas y consulta la pregunta de inmediato.

    embeddedGenerativeQnExperience.setQuestion('show me monthly revenue');
  • Cerrar el panel de respuestas (se aplica a la opción de la barra de búsqueda preguntas y respuestas generativas): esta característica cierra el panel de respuestas y devuelve el iframe al estado original de la barra de búsqueda.

    embeddedGenerativeQnExperience.close();

Para obtener más información, consulte el SDK de incrustación de Amazon Quick Sight.