mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 19:13:14 -04:00
[OAS] Add defaultModel to generative AI connector (#166394)
This commit is contained in:
parent
807856abd2
commit
82024c240a
6 changed files with 154 additions and 24 deletions
|
@ -1005,6 +1005,8 @@ Any modifications made to this file will be overwritten.
|
||||||
<li><a href="#config_properties_d3security"><code>config_properties_d3security</code> - Connector request properties for a D3 Security connector</a></li>
|
<li><a href="#config_properties_d3security"><code>config_properties_d3security</code> - Connector request properties for a D3 Security connector</a></li>
|
||||||
<li><a href="#config_properties_email"><code>config_properties_email</code> - Connector request properties for an email connector</a></li>
|
<li><a href="#config_properties_email"><code>config_properties_email</code> - Connector request properties for an email connector</a></li>
|
||||||
<li><a href="#config_properties_genai"><code>config_properties_genai</code> - Connector request properties for a generative AI connector</a></li>
|
<li><a href="#config_properties_genai"><code>config_properties_genai</code> - Connector request properties for a generative AI connector</a></li>
|
||||||
|
<li><a href="#config_properties_genai_oneOf"><code>config_properties_genai_oneOf</code> - </a></li>
|
||||||
|
<li><a href="#config_properties_genai_oneOf_1"><code>config_properties_genai_oneOf_1</code> - </a></li>
|
||||||
<li><a href="#config_properties_index"><code>config_properties_index</code> - Connector request properties for an index connector</a></li>
|
<li><a href="#config_properties_index"><code>config_properties_index</code> - Connector request properties for an index connector</a></li>
|
||||||
<li><a href="#config_properties_jira"><code>config_properties_jira</code> - Connector request properties for a Jira connector</a></li>
|
<li><a href="#config_properties_jira"><code>config_properties_jira</code> - Connector request properties for a Jira connector</a></li>
|
||||||
<li><a href="#config_properties_opsgenie"><code>config_properties_opsgenie</code> - Connector request properties for an Opsgenie connector</a></li>
|
<li><a href="#config_properties_opsgenie"><code>config_properties_opsgenie</code> - Connector request properties for an Opsgenie connector</a></li>
|
||||||
|
@ -1352,6 +1354,9 @@ Any modifications made to this file will be overwritten.
|
||||||
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </div>
|
<div class="param">config </div><div class="param-desc"><span class="param-type"><a href="#config_properties_xmatters">config_properties_xmatters</a></span> </div>
|
||||||
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
|
<div class="param">name </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The display name for the connector. </div>
|
||||||
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
|
<div class="param">secrets </div><div class="param-desc"><span class="param-type"><a href="#secrets_properties_xmatters">secrets_properties_xmatters</a></span> </div>
|
||||||
|
<div class="param">connector_type_id </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The type of connector. </div>
|
||||||
|
<div class="param-enum-header">Enum:</div>
|
||||||
|
<div class="param-enum">.gen-ai</div>
|
||||||
</div> <!-- field-items -->
|
</div> <!-- field-items -->
|
||||||
</div>
|
</div>
|
||||||
<div class="model">
|
<div class="model">
|
||||||
|
@ -1422,8 +1427,32 @@ Any modifications made to this file will be overwritten.
|
||||||
<h3><a name="config_properties_genai"><code>config_properties_genai</code> - Connector request properties for a generative AI connector</a> <a class="up" href="#__Models">Up</a></h3>
|
<h3><a name="config_properties_genai"><code>config_properties_genai</code> - Connector request properties for a generative AI connector</a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
<div class='model-description'>Defines properties for connectors when type is <code>.gen-ai</code>.</div>
|
<div class='model-description'>Defines properties for connectors when type is <code>.gen-ai</code>.</div>
|
||||||
<div class="field-items">
|
<div class="field-items">
|
||||||
<div class="param">apiProvider (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
<div class="param">apiProvider </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
||||||
<div class="param">apiUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
<div class="param-enum-header">Enum:</div>
|
||||||
|
<div class="param-enum">OpenAI</div>
|
||||||
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
||||||
|
<div class="param">defaultModel (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The default model to use for requests. </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="config_properties_genai_oneOf"><code>config_properties_genai_oneOf</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'></div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">apiProvider </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
||||||
|
<div class="param-enum-header">Enum:</div>
|
||||||
|
<div class="param-enum">Azure OpenAI</div>
|
||||||
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
||||||
|
</div> <!-- field-items -->
|
||||||
|
</div>
|
||||||
|
<div class="model">
|
||||||
|
<h3><a name="config_properties_genai_oneOf_1"><code>config_properties_genai_oneOf_1</code> - </a> <a class="up" href="#__Models">Up</a></h3>
|
||||||
|
<div class='model-description'></div>
|
||||||
|
<div class="field-items">
|
||||||
|
<div class="param">apiProvider </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API provider. </div>
|
||||||
|
<div class="param-enum-header">Enum:</div>
|
||||||
|
<div class="param-enum">OpenAI</div>
|
||||||
|
<div class="param">apiUrl </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The OpenAI API endpoint. </div>
|
||||||
|
<div class="param">defaultModel (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> The default model to use for requests. </div>
|
||||||
</div> <!-- field-items -->
|
</div> <!-- field-items -->
|
||||||
</div>
|
</div>
|
||||||
<div class="model">
|
<div class="model">
|
||||||
|
|
|
@ -469,6 +469,9 @@
|
||||||
{
|
{
|
||||||
"$ref": "#/components/schemas/update_connector_request_email"
|
"$ref": "#/components/schemas/update_connector_request_email"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"$ref": "#/components/schemas/create_connector_request_genai"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"$ref": "#/components/schemas/update_connector_request_index"
|
"$ref": "#/components/schemas/update_connector_request_index"
|
||||||
},
|
},
|
||||||
|
@ -1755,11 +1758,20 @@
|
||||||
"config_properties_genai": {
|
"config_properties_genai": {
|
||||||
"title": "Connector request properties for a generative AI connector",
|
"title": "Connector request properties for a generative AI connector",
|
||||||
"description": "Defines properties for connectors when type is `.gen-ai`.",
|
"description": "Defines properties for connectors when type is `.gen-ai`.",
|
||||||
|
"oneOf": [
|
||||||
|
{
|
||||||
"type": "object",
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"apiProvider",
|
||||||
|
"apiUrl"
|
||||||
|
],
|
||||||
"properties": {
|
"properties": {
|
||||||
"apiProvider": {
|
"apiProvider": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
"description": "The OpenAI API provider."
|
"description": "The OpenAI API provider.",
|
||||||
|
"enum": [
|
||||||
|
"Azure OpenAI"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
"apiUrl": {
|
"apiUrl": {
|
||||||
"type": "string",
|
"type": "string",
|
||||||
|
@ -1767,6 +1779,35 @@
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"type": "object",
|
||||||
|
"required": [
|
||||||
|
"apiProvider",
|
||||||
|
"apiUrl"
|
||||||
|
],
|
||||||
|
"properties": {
|
||||||
|
"apiProvider": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The OpenAI API provider.",
|
||||||
|
"enum": [
|
||||||
|
"OpenAI"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"apiUrl": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The OpenAI API endpoint."
|
||||||
|
},
|
||||||
|
"defaultModel": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The default model to use for requests."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"discriminator": {
|
||||||
|
"propertyName": "apiProvider"
|
||||||
|
}
|
||||||
|
},
|
||||||
"secrets_properties_genai": {
|
"secrets_properties_genai": {
|
||||||
"title": "Connector secrets properties for a generative AI connector",
|
"title": "Connector secrets properties for a generative AI connector",
|
||||||
"description": "Defines secrets for connectors when type is `.gen-ai`.",
|
"description": "Defines secrets for connectors when type is `.gen-ai`.",
|
||||||
|
|
|
@ -251,6 +251,7 @@ paths:
|
||||||
- $ref: '#/components/schemas/update_connector_request_cases_webhook'
|
- $ref: '#/components/schemas/update_connector_request_cases_webhook'
|
||||||
- $ref: '#/components/schemas/update_connector_request_d3security'
|
- $ref: '#/components/schemas/update_connector_request_d3security'
|
||||||
- $ref: '#/components/schemas/update_connector_request_email'
|
- $ref: '#/components/schemas/update_connector_request_email'
|
||||||
|
- $ref: '#/components/schemas/create_connector_request_genai'
|
||||||
- $ref: '#/components/schemas/update_connector_request_index'
|
- $ref: '#/components/schemas/update_connector_request_index'
|
||||||
- $ref: '#/components/schemas/update_connector_request_jira'
|
- $ref: '#/components/schemas/update_connector_request_jira'
|
||||||
- $ref: '#/components/schemas/update_connector_request_opsgenie'
|
- $ref: '#/components/schemas/update_connector_request_opsgenie'
|
||||||
|
@ -1100,14 +1101,38 @@ components:
|
||||||
config_properties_genai:
|
config_properties_genai:
|
||||||
title: Connector request properties for a generative AI connector
|
title: Connector request properties for a generative AI connector
|
||||||
description: Defines properties for connectors when type is `.gen-ai`.
|
description: Defines properties for connectors when type is `.gen-ai`.
|
||||||
type: object
|
oneOf:
|
||||||
|
- type: object
|
||||||
|
required:
|
||||||
|
- apiProvider
|
||||||
|
- apiUrl
|
||||||
properties:
|
properties:
|
||||||
apiProvider:
|
apiProvider:
|
||||||
type: string
|
type: string
|
||||||
description: The OpenAI API provider.
|
description: The OpenAI API provider.
|
||||||
|
enum:
|
||||||
|
- Azure OpenAI
|
||||||
apiUrl:
|
apiUrl:
|
||||||
type: string
|
type: string
|
||||||
description: The OpenAI API endpoint.
|
description: The OpenAI API endpoint.
|
||||||
|
- type: object
|
||||||
|
required:
|
||||||
|
- apiProvider
|
||||||
|
- apiUrl
|
||||||
|
properties:
|
||||||
|
apiProvider:
|
||||||
|
type: string
|
||||||
|
description: The OpenAI API provider.
|
||||||
|
enum:
|
||||||
|
- OpenAI
|
||||||
|
apiUrl:
|
||||||
|
type: string
|
||||||
|
description: The OpenAI API endpoint.
|
||||||
|
defaultModel:
|
||||||
|
type: string
|
||||||
|
description: The default model to use for requests.
|
||||||
|
discriminator:
|
||||||
|
propertyName: apiProvider
|
||||||
secrets_properties_genai:
|
secrets_properties_genai:
|
||||||
title: Connector secrets properties for a generative AI connector
|
title: Connector secrets properties for a generative AI connector
|
||||||
description: Defines secrets for connectors when type is `.gen-ai`.
|
description: Defines secrets for connectors when type is `.gen-ai`.
|
||||||
|
|
|
@ -1,10 +1,32 @@
|
||||||
title: Connector request properties for a generative AI connector
|
title: Connector request properties for a generative AI connector
|
||||||
description: Defines properties for connectors when type is `.gen-ai`.
|
description: Defines properties for connectors when type is `.gen-ai`.
|
||||||
type: object
|
oneOf:
|
||||||
properties:
|
- type: object
|
||||||
|
required:
|
||||||
|
- apiProvider
|
||||||
|
- apiUrl
|
||||||
|
properties:
|
||||||
apiProvider:
|
apiProvider:
|
||||||
type: string
|
type: string
|
||||||
description: The OpenAI API provider.
|
description: The OpenAI API provider.
|
||||||
|
enum: ['Azure OpenAI']
|
||||||
apiUrl:
|
apiUrl:
|
||||||
type: string
|
type: string
|
||||||
description: The OpenAI API endpoint.
|
description: The OpenAI API endpoint.
|
||||||
|
- type: object
|
||||||
|
required:
|
||||||
|
- apiProvider
|
||||||
|
- apiUrl
|
||||||
|
properties:
|
||||||
|
apiProvider:
|
||||||
|
type: string
|
||||||
|
description: The OpenAI API provider.
|
||||||
|
enum: ['OpenAI']
|
||||||
|
apiUrl:
|
||||||
|
type: string
|
||||||
|
description: The OpenAI API endpoint.
|
||||||
|
defaultModel:
|
||||||
|
type: string
|
||||||
|
description: The default model to use for requests.
|
||||||
|
discriminator:
|
||||||
|
propertyName: apiProvider
|
|
@ -0,0 +1,13 @@
|
||||||
|
title: Update generative AI connector request
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- config
|
||||||
|
- name
|
||||||
|
properties:
|
||||||
|
config:
|
||||||
|
$ref: 'config_properties_genai.yaml'
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
description: The display name for the connector.
|
||||||
|
secrets:
|
||||||
|
$ref: 'secrets_properties_genai.yaml'
|
|
@ -162,7 +162,7 @@ put:
|
||||||
- $ref: '../components/schemas/update_connector_request_cases_webhook.yaml'
|
- $ref: '../components/schemas/update_connector_request_cases_webhook.yaml'
|
||||||
- $ref: '../components/schemas/update_connector_request_d3security.yaml'
|
- $ref: '../components/schemas/update_connector_request_d3security.yaml'
|
||||||
- $ref: '../components/schemas/update_connector_request_email.yaml'
|
- $ref: '../components/schemas/update_connector_request_email.yaml'
|
||||||
# - $ref: '../components/schemas/create_connector_request_genai.yaml'
|
- $ref: '../components/schemas/create_connector_request_genai.yaml'
|
||||||
- $ref: '../components/schemas/update_connector_request_index.yaml'
|
- $ref: '../components/schemas/update_connector_request_index.yaml'
|
||||||
- $ref: '../components/schemas/update_connector_request_jira.yaml'
|
- $ref: '../components/schemas/update_connector_request_jira.yaml'
|
||||||
- $ref: '../components/schemas/update_connector_request_opsgenie.yaml'
|
- $ref: '../components/schemas/update_connector_request_opsgenie.yaml'
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue