@promptbook/openai 0.59.0-30 → 0.59.0-32

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 (27) hide show
  1. package/esm/index.es.js +114 -45
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/core.index.d.ts +2 -1
  4. package/esm/typings/src/_packages/types.index.d.ts +3 -2
  5. package/esm/typings/src/conversion/promptbookStringToJson.d.ts +1 -0
  6. package/esm/typings/src/execution/EmbeddingVector.d.ts +8 -0
  7. package/esm/typings/src/execution/PromptResult.d.ts +11 -0
  8. package/esm/typings/src/execution/embeddingVectorToString.d.ts +5 -0
  9. package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +4 -0
  10. package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +7 -2
  11. package/esm/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts +4 -2
  12. package/esm/typings/src/types/PromptbookJson/MaterialKnowledgePieceJson.d.ts +2 -1
  13. package/package.json +4 -3
  14. package/umd/index.umd.js +118 -49
  15. package/umd/index.umd.js.map +1 -1
  16. package/umd/typings/src/_packages/core.index.d.ts +2 -1
  17. package/umd/typings/src/_packages/types.index.d.ts +3 -2
  18. package/umd/typings/src/conversion/promptbookStringToJson.d.ts +1 -0
  19. package/umd/typings/src/execution/EmbeddingVector.d.ts +8 -0
  20. package/umd/typings/src/execution/PromptResult.d.ts +11 -0
  21. package/umd/typings/src/execution/embeddingVectorToString.d.ts +5 -0
  22. package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +4 -0
  23. package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +7 -2
  24. package/umd/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts +4 -2
  25. package/umd/typings/src/types/PromptbookJson/MaterialKnowledgePieceJson.d.ts +2 -1
  26. package/esm/typings/src/knowledge/prepare-knowledge/_common/IndexPreparer.d.ts +0 -4
  27. package/umd/typings/src/knowledge/prepare-knowledge/_common/IndexPreparer.d.ts +0 -4
@@ -1,12 +1,14 @@
1
1
  import type OpenAI from 'openai';
2
- import type { PromptResult } from '../../execution/PromptResult';
3
2
  import type { PromptResultUsage } from '../../execution/PromptResult';
4
3
  import type { Prompt } from '../../types/Prompt';
5
4
  /**
6
5
  * Computes the usage of the OpenAI API based on the response from OpenAI
7
6
  *
7
+ * @param promptContent The content of the prompt
8
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
9
+ * @param rawResponse The raw response from OpenAI API
8
10
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
9
11
  * @private internal util of `OpenAiExecutionTools`
10
12
  */
11
13
  export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
12
- resultContent: PromptResult['content'], rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResultUsage;
14
+ resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;
@@ -1,3 +1,4 @@
1
+ import type { EmbeddingVector } from '../../execution/EmbeddingVector';
1
2
  import type { string_keyword } from '../../utils/normalization/IKeywords';
2
3
  import type { string_href } from '../typeAliases';
3
4
  import type { string_markdown } from '../typeAliases';
@@ -11,7 +12,7 @@ export type MaterialKnowledgePieceJson = {
11
12
  readonly keywords: Array<string_keyword>;
12
13
  readonly index: Array<{
13
14
  modelName: string_model_name;
14
- position: Array<number>;
15
+ position: EmbeddingVector;
15
16
  }>;
16
17
  readonly sources: Array<{
17
18
  title: string_markdown_text;
@@ -1,4 +0,0 @@
1
- export type IndexPreparer = {};
2
- /**
3
- * TODO: Export via some package
4
- */
@@ -1,4 +0,0 @@
1
- export type IndexPreparer = {};
2
- /**
3
- * TODO: Export via some package
4
- */