Ottenere l'endpoint dell'API

L'endpoint dell'API di watsonx Orchestrate varia a seconda dell'offerta che si utilizza.

Seguite le istruzioni per la vostra offerta specifica per trovare l'endpoint corretto.

IBM Cloud offerta

Per ottenere l'endpoint API dell'offerta IBM Cloud :

  1. Accedi al tuo account watsonx Orchestrate.

  2. Fai clic sull'icona del tuo profilo > Impostazioni.

Icona utente e opzione Impostazioni

  1. Selezionare la scheda Dettagli API.

  2. Copia l' URL dell'istanza del servizio.

Il formato dell'endpoint è:

https://<hostname>/instances/<tenant_id>

dove:

  • <hostname> è il sito web watsonx Orchestrate URL. I formati più comuni includono:

    • https://api.<ibm-cloud-region>.watson.cloud.ibm.com/

    • https://api.<ibm-cloud-region>.cloud.ibm.com/

  • <tenant_id> è l'ID del tuo tenant di watsonx Orchestrate.

Offerta di Amazon Web ServicesAWS )

Per ottenere l'endpoint API dell'offerta AWS :

  1. Accedi al tuo account watsonx Orchestrate.

  2. Fai clic sull'icona del tuo profilo > Impostazioni.

Icona utente e opzione Impostazioni

  1. Selezionare la scheda Dettagli API.

  2. Copia l' URL dell'istanza del servizio.

Il formato dell'endpoint è:

https://api.<region_code>.watson-orchestrate.ibm.com/instances/<tenant_id>

dove:

  • <region_code> è la regione AWS in cui è ospitata l'istanza.

  • <tenant_id> è l'ID del tuo tenant di watsonx Orchestrate.

Offerta on-premises

Per l'offerta on-premises, l'endpoint dipende dall'API che si desidera utilizzare:

  • watsonx Orchestrate API

  • API del costruttore dell'assistente AI

Endpoint API di AI Assistant Builder:

https://{onprem_host}:{port}/assistant/{namespace}/instances/{instance_id}/api

watsonx Orchestrate Endpoint API:

https://{onprem_host}:{port}/orchestrate/{namespace}/instances/{instanceid}/v1

Parametri:

  • {onprem_host}: Nome host o indirizzo IP del cluster IBM Software Hub (ad esempio, api.example.com).

Lo trovi nel client web di IBM Software Hub, nella sezione dei dettagli dell'istanza.

  • {port}: Numero di porta, se richiesto (ad esempio, cpd.example.com:31843).

  • {namespace}: Spazio dei nomi in cui è distribuita l'istanza. Recuperarlo utilizzando l'API Get service instance details.

  • {instanceid}: Identificatore univoco dell'istanza. Per watsonx Orchestrate, si tratta del numero che segue orchestrate- nei dettagli dell'istanza URL.