16
16
version_type :
17
17
type : string
18
18
docs : >-
19
- Inidicates whether this tool is using a fixed version number or
19
+ Indicates whether this tool is using a fixed version number or
20
20
auto-updating to the latest version. Values from the VersionType enum.
21
21
version_description :
22
22
type : optional<string>
55
55
version_type :
56
56
type : string
57
57
docs : >-
58
- Inidicates whether this prompt is using a fixed version number or
58
+ Indicates whether this prompt is using a fixed version number or
59
59
auto-updating to the latest version. Values from the VersionType enum.
60
60
version_description :
61
61
type : optional<string>
@@ -175,12 +175,8 @@ types:
175
175
prompt : optional<ReturnPrompt>
176
176
voice : optional<ReturnVoice>
177
177
language_model : optional<ReturnLanguageModel>
178
- tools :
179
- type : optional<list<optional<ReturnUserDefinedTool>>>
180
- docs : List of user-defined tools associated with this config.
181
- builtin_tools :
182
- type : optional<list<optional<ReturnBuiltinTool>>>
183
- docs : List of built-in tools associated with this config
178
+ tools : optional<ReturnUserDefinedTool>
179
+ builtin_tools : optional<ReturnBuiltinTool>
184
180
ReturnLanguageModel :
185
181
docs : A specific LanguageModel
186
182
properties :
@@ -510,7 +506,11 @@ types:
510
506
AssistantEnd :
511
507
docs : When provided, the output is an assistant end message.
512
508
properties :
513
- custom_session_id : optional<string>
509
+ custom_session_id :
510
+ type : optional<string>
511
+ docs : >-
512
+ Used to manage conversational state, correlate frontend and backend
513
+ data, and persist conversations across EVI sessions.
514
514
type :
515
515
type : literal<"assistant_end">
516
516
docs : >-
@@ -519,7 +519,11 @@ types:
519
519
AssistantInput :
520
520
docs : When provided, the input is spoken by EVI.
521
521
properties :
522
- custom_session_id : optional<string>
522
+ custom_session_id :
523
+ type : optional<string>
524
+ docs : >-
525
+ Used to manage conversational state, correlate frontend and backend
526
+ data, and persist conversations across EVI sessions.
523
527
text :
524
528
type : string
525
529
docs : Text to be synthesized.
@@ -531,7 +535,11 @@ types:
531
535
AssistantMessage :
532
536
docs : When provided, the output is an assistant message.
533
537
properties :
534
- custom_session_id : optional<string>
538
+ custom_session_id :
539
+ type : optional<string>
540
+ docs : >-
541
+ Used to manage conversational state, correlate frontend and backend
542
+ data, and persist conversations across EVI sessions.
535
543
from_text :
536
544
type : boolean
537
545
docs : Indicates if this message was constructed from a text input message.
@@ -563,7 +571,11 @@ types:
563
571
AudioInput :
564
572
docs : When provided, the input is audio.
565
573
properties :
566
- custom_session_id : optional<string>
574
+ custom_session_id :
575
+ type : optional<string>
576
+ docs : >-
577
+ Used to manage conversational state, correlate frontend and backend
578
+ data, and persist conversations across EVI sessions.
567
579
data :
568
580
type : string
569
581
docs : Base64 encoded audio input.
@@ -577,7 +589,11 @@ types:
577
589
AudioOutput :
578
590
docs : When provided, the output is audio.
579
591
properties :
580
- custom_session_id : optional<string>
592
+ custom_session_id :
593
+ type : optional<string>
594
+ docs : >-
595
+ Used to manage conversational state, correlate frontend and backend
596
+ data, and persist conversations across EVI sessions.
581
597
data :
582
598
type : string
583
599
docs : Base64 encoded audio output.
@@ -604,11 +620,15 @@ types:
604
620
- ToolErrorMessage
605
621
ChatMessage :
606
622
properties :
607
- content : optional<string>
623
+ content :
624
+ type : optional<string>
625
+ docs : Transcript of the message.
608
626
role :
609
627
type : Role
610
628
docs : Role of who is providing the message.
611
- tool_call : optional<ToolCallMessage>
629
+ tool_call :
630
+ type : optional<ToolCallMessage>
631
+ docs : Function call name and arguments.
612
632
tool_result :
613
633
type : optional<ChatMessageToolResult>
614
634
docs : Function call response from client.
@@ -621,7 +641,11 @@ types:
621
641
chat_id :
622
642
type : string
623
643
docs : ID of the chat.
624
- custom_session_id : optional<string>
644
+ custom_session_id :
645
+ type : optional<string>
646
+ docs : >-
647
+ Used to manage conversational state, correlate frontend and backend
648
+ data, and persist conversations across EVI sessions.
625
649
type :
626
650
type : literal<"chat_metadata">
627
651
docs : >-
@@ -697,7 +721,11 @@ types:
697
721
code :
698
722
type : string
699
723
docs : Error code.
700
- custom_session_id : optional<string>
724
+ custom_session_id :
725
+ type : optional<string>
726
+ docs : >-
727
+ Used to manage conversational state, correlate frontend and backend
728
+ data, and persist conversations across EVI sessions.
701
729
message :
702
730
type : string
703
731
docs : Error message.
@@ -712,7 +740,9 @@ types:
712
740
ErrorLevel : literal<"warn">
713
741
Inference :
714
742
properties :
715
- prosody : optional<ProsodyInference>
743
+ prosody :
744
+ type : optional<ProsodyInference>
745
+ docs : Prosody model inference results.
716
746
MillisecondInterval :
717
747
properties :
718
748
begin :
@@ -726,7 +756,11 @@ types:
726
756
Pause responses from EVI. Chat history is still saved and sent after
727
757
resuming.
728
758
properties :
729
- custom_session_id : optional<string>
759
+ custom_session_id :
760
+ type : optional<string>
761
+ docs : >-
762
+ Used to manage conversational state, correlate frontend and backend
763
+ data, and persist conversations across EVI sessions.
730
764
type :
731
765
type : optional<literal<"pause_assistant_message">>
732
766
docs : >-
@@ -740,7 +774,11 @@ types:
740
774
Resume responses from EVI. Chat history sent while paused will now be
741
775
sent.
742
776
properties :
743
- custom_session_id : optional<string>
777
+ custom_session_id :
778
+ type : optional<string>
779
+ docs : >-
780
+ Used to manage conversational state, correlate frontend and backend
781
+ data, and persist conversations across EVI sessions.
744
782
type :
745
783
type : optional<literal<"resume_assistant_message">>
746
784
docs : >-
@@ -756,21 +794,43 @@ types:
756
794
SessionSettings :
757
795
docs : Settings for this chat session.
758
796
properties :
759
- audio : optional<AudioConfiguration>
760
- builtin_tools : optional<list<BuiltinToolConfig>>
761
- custom_session_id : optional<string>
762
- language_model_api_key : optional<string>
763
- system_prompt : optional<string>
764
- tools : optional<list<Tool>>
797
+ audio :
798
+ type : optional<AudioConfiguration>
799
+ docs : Audio configuration.
800
+ builtin_tools :
801
+ type : optional<list<BuiltinToolConfig>>
802
+ docs : List of builtin tools to enable.
803
+ custom_session_id :
804
+ type : optional<string>
805
+ docs : >-
806
+ Used to manage conversational state, correlate frontend and backend
807
+ data, and persist conversations across EVI sessions.
808
+ language_model_api_key :
809
+ type : optional<string>
810
+ docs : Third party API key for the language model used for non-Hume models.
811
+ system_prompt :
812
+ type : optional<string>
813
+ docs : >-
814
+ Instructions for how the system should respond to the user. Set to
815
+ null to use the default system prompt.
816
+ tools :
817
+ type : optional<list<Tool>>
818
+ docs : List of tools to enable.
765
819
type :
766
820
type : literal<"session_settings">
767
821
docs : >-
768
822
The type of message sent through the socket; for a Session Settings
769
823
message, this must be 'session_settings'.
770
824
Tool :
771
825
properties :
772
- description : optional<string>
773
- fallback_content : optional<string>
826
+ description :
827
+ type : optional<string>
828
+ docs : Description of the function.
829
+ fallback_content :
830
+ type : optional<string>
831
+ docs : >-
832
+ Fallback content of the tool, passed to the LLM if the function call
833
+ response fails.
774
834
name :
775
835
type : string
776
836
docs : Name of the tool.
@@ -783,7 +843,11 @@ types:
783
843
ToolCallMessage :
784
844
docs : When provided, the output is a tool call.
785
845
properties :
786
- custom_session_id : optional<string>
846
+ custom_session_id :
847
+ type : optional<string>
848
+ docs : >-
849
+ Used to manage conversational state, correlate frontend and backend
850
+ data, and persist conversations across EVI sessions.
787
851
name :
788
852
type : string
789
853
docs : Name of the tool called.
@@ -807,17 +871,29 @@ types:
807
871
ToolErrorMessage :
808
872
docs : When provided, the output is a function call error.
809
873
properties :
810
- code : optional<string>
811
- content : optional<string>
812
- custom_session_id : optional<string>
874
+ code :
875
+ type : optional<string>
876
+ docs : Error code.
877
+ content :
878
+ type : optional<string>
879
+ docs : The content passed to the LLM in place of the tool response.
880
+ custom_session_id :
881
+ type : optional<string>
882
+ docs : >-
883
+ Used to manage conversational state, correlate frontend and backend
884
+ data, and persist conversations across EVI sessions.
813
885
error :
814
886
type : string
815
887
docs : Error message from the tool call, not exposed to the LLM or user.
816
- level : optional<ErrorLevel>
888
+ level :
889
+ type : optional<ErrorLevel>
890
+ docs : Error level.
817
891
tool_call_id :
818
892
type : string
819
893
docs : ID of the tool call.
820
- tool_type : optional<ToolType>
894
+ tool_type :
895
+ type : optional<ToolType>
896
+ docs : Type of tool called, either 'builtin' or 'function'.
821
897
type :
822
898
type : optional<literal<"tool_error">>
823
899
docs : >-
@@ -829,7 +905,11 @@ types:
829
905
content :
830
906
type : string
831
907
docs : Return value of the tool call.
832
- custom_session_id : optional<string>
908
+ custom_session_id :
909
+ type : optional<string>
910
+ docs : >-
911
+ Used to manage conversational state, correlate frontend and backend
912
+ data, and persist conversations across EVI sessions.
833
913
tool_call_id :
834
914
type : string
835
915
docs : ID of the tool call.
@@ -847,7 +927,11 @@ types:
847
927
UserInput :
848
928
docs : User text to insert into the conversation.
849
929
properties :
850
- custom_session_id : optional<string>
930
+ custom_session_id :
931
+ type : optional<string>
932
+ docs : >-
933
+ Used to manage conversational state, correlate frontend and backend
934
+ data, and persist conversations across EVI sessions.
851
935
text :
852
936
type : string
853
937
docs : User text to insert into the conversation.
@@ -859,7 +943,11 @@ types:
859
943
UserInterruption :
860
944
docs : When provided, the output is an interruption.
861
945
properties :
862
- custom_session_id : optional<string>
946
+ custom_session_id :
947
+ type : optional<string>
948
+ docs : >-
949
+ Used to manage conversational state, correlate frontend and backend
950
+ data, and persist conversations across EVI sessions.
863
951
time :
864
952
type : integer
865
953
docs : Unix timestamp of the detected user interruption.
@@ -871,7 +959,11 @@ types:
871
959
UserMessage :
872
960
docs : When provided, the output is a user message.
873
961
properties :
874
- custom_session_id : optional<string>
962
+ custom_session_id :
963
+ type : optional<string>
964
+ docs : >-
965
+ Used to manage conversational state, correlate frontend and backend
966
+ data, and persist conversations across EVI sessions.
875
967
from_text :
876
968
type : boolean
877
969
docs : Indicates if this message was constructed from a text input message.
0 commit comments