@elizaos/plugin-openai 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1) hide show
  1. package/package.json +48 -36
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elizaos/plugin-openai",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "type": "module",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",
@@ -46,84 +46,96 @@
46
46
  "pluginParameters": {
47
47
  "OPENAI_API_KEY": {
48
48
  "type": "string",
49
- "description": "API key for the service"
49
+ "description": "API key used to authenticate requests to the OpenAI API.",
50
+ "required": false,
51
+ "sensitive": true
50
52
  },
51
53
  "OPENAI_BASE_URL": {
52
54
  "type": "string",
53
- "description": "Custom OpenAI API endpoint",
55
+ "description": "Base URL for all OpenAI API requests.",
54
56
  "required": false,
55
- "default": "https://api.openai.com/v1"
57
+ "default": "https://api.openai.com/v1",
58
+ "sensitive": false
56
59
  },
57
60
  "OPENAI_SMALL_MODEL": {
58
61
  "type": "string",
59
- "description": "Model ID for small/fast text tasks",
62
+ "description": "Identifier of the small language model to be used (overrides SMALL_MODEL).",
63
+ "required": false,
64
+ "sensitive": false
65
+ },
66
+ "SMALL_MODEL": {
67
+ "type": "string",
68
+ "description": "Fallback identifier for the small language model if OPENAI_SMALL_MODEL is not set.",
60
69
  "required": false,
61
- "default": "gpt-4o-mini"
70
+ "default": "gpt-4o-mini",
71
+ "sensitive": false
62
72
  },
63
73
  "OPENAI_LARGE_MODEL": {
64
74
  "type": "string",
65
- "description": "Model ID for large/complex text tasks",
75
+ "description": "Identifier of the large language model to be used (overrides LARGE_MODEL).",
76
+ "required": false,
77
+ "sensitive": false
78
+ },
79
+ "LARGE_MODEL": {
80
+ "type": "string",
81
+ "description": "Fallback identifier for the large language model if OPENAI_LARGE_MODEL is not set.",
66
82
  "required": false,
67
- "default": "gpt-4o"
83
+ "default": "gpt-4o",
84
+ "sensitive": false
68
85
  },
69
86
  "OPENAI_EMBEDDING_MODEL": {
70
87
  "type": "string",
71
- "description": "Model ID used for generating text embeddings",
88
+ "description": "Identifier of the model to use for generating text embeddings.",
72
89
  "required": false,
73
- "default": "text-embedding-3-small"
90
+ "default": "text-embedding-3-small",
91
+ "sensitive": false
74
92
  },
75
93
  "OPENAI_EMBEDDING_URL": {
76
94
  "type": "string",
77
- "description": "Custom endpoint for embedding requests",
95
+ "description": "Custom base URL for the OpenAI embeddings endpoint.",
78
96
  "required": false,
79
- "default": "value of OPENAI_BASE_URL if not set"
97
+ "sensitive": false
80
98
  },
81
99
  "OPENAI_EMBEDDING_DIMENSIONS": {
82
100
  "type": "number",
83
- "description": "Number of dimensions for embedding vectors",
101
+ "description": "Number of dimensions for the returned embedding vectors.",
84
102
  "required": false,
85
- "default": 1536
103
+ "default": 1536,
104
+ "sensitive": false
86
105
  },
87
106
  "OPENAI_IMAGE_DESCRIPTION_MODEL": {
88
107
  "type": "string",
89
- "description": "Model ID used for image description tasks",
108
+ "description": "Identifier of the model used for describing images.",
90
109
  "required": false,
91
- "default": "gpt-4o-mini"
110
+ "default": "gpt-4o-mini",
111
+ "sensitive": false
92
112
  },
93
113
  "OPENAI_IMAGE_DESCRIPTION_MAX_TOKENS": {
94
114
  "type": "number",
95
- "description": "Maximum tokens allowed for image description responses",
115
+ "description": "Maximum number of tokens allowed in the image-description model response.",
96
116
  "required": false,
97
- "default": 8192
98
- },
99
- "SMALL_MODEL": {
100
- "type": "string",
101
- "description": "Generic fallback small model name if provider-specific variable is not set",
102
- "required": false,
103
- "default": "gpt-4o-mini"
104
- },
105
- "LARGE_MODEL": {
106
- "type": "string",
107
- "description": "Generic fallback large model name if provider-specific variable is not set",
108
- "required": false,
109
- "default": "gpt-4o"
117
+ "default": 8192,
118
+ "sensitive": false
110
119
  },
111
120
  "OPENAI_TTS_MODEL": {
112
121
  "type": "string",
113
- "description": "Model name to be used for text-to-speech requests",
122
+ "description": "Identifier of the model used for text-to-speech generation.",
114
123
  "required": false,
115
- "default": "gpt-4o-mini-tts"
124
+ "default": "gpt-4o-mini-tts",
125
+ "sensitive": false
116
126
  },
117
127
  "OPENAI_TTS_VOICE": {
118
128
  "type": "string",
119
- "description": "Voice preset to use with text-to-speech generation",
129
+ "description": "Voice profile to use for text-to-speech output.",
120
130
  "required": false,
121
- "default": "nova"
131
+ "default": "nova",
132
+ "sensitive": false
122
133
  },
123
134
  "OPENAI_TTS_INSTRUCTIONS": {
124
135
  "type": "string",
125
- "description": "Custom instructions or style prompts for text-to-speech output",
126
- "required": false
136
+ "description": "Optional instructions to control the style or behavior of the text-to-speech request.",
137
+ "required": false,
138
+ "sensitive": false
127
139
  }
128
140
  }
129
141
  },