github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

OpenAI (Other) Connector PKI implementation (#219984)

Browse source
This commit is contained in:
Antonio Piazza 2025-06-06 22:43:57 +02:00 • committed by GitHub
parent 9f7cffc4f3
commit 8fae18a9b2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 1429 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

38
docs/reference/connectors-kibana/openai-action-type.md
View file

@ -9,7 +9,7 @@ applies_to:
# OpenAI connector and action [openai-action-type]
The OpenAI connector uses [axios](https://github.com/axios/axios) to send a POST request to an OpenAI provider, either OpenAI or Azure OpenAI.
The OpenAI connector uses [axios](https://github.com/axios/axios) to send a POST request to an OpenAI provider, either OpenAI, Azure OpenAI, or Other (OpenAI-compatible service).
## Create connectors in {{kib}} [define-gen-ai-ui]
@ -30,20 +30,36 @@ To validate that your connectivity problems are caused by using a proxy, you can
OpenAI connectors have the following configuration properties:
Name
: The name of the connector.
| Field | Required for | Description |
|------------------|---------------------|---------------------------------------------------------------------------------------------|
| Name | All | The name of the connector. |
| OpenAI provider | All | The API provider: `OpenAI`, `Azure OpenAI`, or `Other` (OpenAI-compatible service). |
| URL | All | The API endpoint URL for the selected provider. |
| Default model | OpenAI/Other | The default model for requests. **Required** for `Other`, optional for `OpenAI`. |
| Headers | Optional | Custom HTTP headers to include in requests. |
| Verification mode| Other (PKI only) | SSL verification mode for PKI authentication. Default: `full`. |
| API key | OpenAI/Azure/Other | The API key for authentication. **Required** for `OpenAI` and `Azure OpenAI`. For `Other`, required unless PKI authentication is used. |
| PKI fields | Other (PKI only) | See below. Only available for `Other` provider. |
OpenAI provider
: The OpenAI API provider, either OpenAI or Azure OpenAI.
#### PKI Authentication (Other provider only)
URL
: The OpenAI request URL.
When using the `Other` provider, you can use PKI (certificate-based) authentication. With PKI, you can also optionally include an API key if your OpenAI-compatible service supports or requires one. The following fields are supported for PKI:
Default model
: (optional) The default model to use for requests. This option is available only when the provider is `OpenAI`.
- **Certificate data** (`certificateData`): PEM-encoded certificate content, base64-encoded. (**Required for PKI**)
- **Private key data** (`privateKeyData`): PEM-encoded private key content, base64-encoded. (**Required for PKI**)
- **CA data** (`caData`, optional): PEM-encoded CA certificate content, base64-encoded.
- **API key** (`apiKey`, optional): The API key for authentication, if required by your service.
- **Verification mode** (`verificationMode`): SSL verification mode for PKI authentication. Options:
- `full` (default): Verify server's certificate and hostname
- `certificate`: Verify only the server's certificate
- `none`: Skip verification (not recommended for production)
API key
: The OpenAI or Azure OpenAI API key for authentication.
**Note:**
- All PKI fields must be PEM-encoded and base64-encoded when sent via API.
- If any PKI field is provided, both `certificateData` and `privateKeyData` are required and must be valid PEM.
- With PKI, you may also include an API key if your provider supports or requires it.
- If PKI is not used, `apiKey` is required for the `Other` provider.
- For `OpenAI` and `Azure OpenAI`, only `apiKey` is supported for authentication.
## Test connectors [gen-ai-action-configuration]