Set up connection and credential alias for third-party embedding model

  • Versão de lançamento: Australia
  • Atualizado 12 de mar. de 2026
  • 2 min. de leitura

    • Set up connection and credential record for your aliases to authenticate an integration between your ServiceNow instance and third-party embedding model.

    Antes de Iniciar

    Role required: admin

    Por Que e Quando Desempenhar Esta Tarefa

    The system provides the default connection and credential alias for Azure OpenAI Embedding model (text-embedding-3-large) and Gemini Text Embedding model (text-embedding-004). Set up these default alias to manage the secure connection of your ServiceNow instance with either of the embedding model. A connection and credential alias includes the endpoint URL of the models and the login details, such as OAuth token or API keys to tell the system how to connect to these third-party models.

    Procedimento

    1. Navigate to All > Connections & Credentials > Connection & Credential Aliases.
    2. Select an alias that you want to set up.
      • To set up the embedding model alias for Azure OpenAI Embedding, select Azure OpenAI.
      • To set up the embedding model alias for Google Gemini Text Embedding, select Google Gemini API.
    3. Create a connection record for your alias.
      OptionProcedure
      Update the existing connection record
      1. In the Connections related list, select a connection from the connection alias list.
        • Select Azure OpenAI Connection for the Azure OpenAI alias.
        • Select Google gemini API connection for the Google gemini API alias.
      2. Update the Name and Connection URL fields based on your requirement.
      3. Select Update.
      Create a new connection record
      1. In the Connections related list, click New.
      2. On the form, fill in the fields.

        For a description of the field values, see Create an HTTP(s) connection.

      3. Select Submit.
      The connection record is created.
    4. Create a credential record for your alias.
      OptionProcedure
      Update the existing credential record
      1. In the Connections related list, select a connection record from the connection alias list.
        • Select Azure OpenAI Connection for the Azure OpenAI alias.
        • Select Google gemini API connection for the Google gemini API alias.
      2. In the Credentials field, select the Preview this record icon and then select Open Record.

        The API Key Credentials record opens.

      3. Update the API Key field.
      4. Select Update.
      5. Select Update.
      Create a new credential record
      1. In the Connections related list, select a connection record from the connection alias list.
        • Select Azure OpenAI Connection for the Azure OpenAI alias.
        • Select Google gemini API connection for the Google gemini API alias.
      2. In the Credentials field, select the search icon and then select New.
      3. From the list of credentials, select a credential type.
        • To create a credential record for Azure OpenAI alias, select API Key Credentials.
        • To create a credential record for Google Gemini API alias, select OAuth 2.0 Credentials.
      4. On the form, fill in the fields.

        For a description of the field values, see API key credentials or OAuth 2.0 credentials.

      5. Select Submit.
      6. Select Update.
      The credential record is created.

    O que Fazer Depois

    Activate the embedding model to start using it. For more information, see Activate the third-party embedding model.