4e:I[510592,["/_next/static/chunks/1176bnf8oism6.js","/_next/static/chunks/0aiio4ivp1n07.js","/_next/static/chunks/3cauv554e_gxu.js","/_next/static/chunks/3byf1h7-4uxfn.js","/_next/static/chunks/3r5yd4k4rms8-.js","/_next/static/chunks/1la1pzs9j8idc.js","/_next/static/chunks/12haym2zhwrql.js","/_next/static/chunks/0gvbio555n823.js","/_next/static/chunks/3ygl6_80ds9-d.js","/_next/static/chunks/2m_mi71579pjv.js","/_next/static/chunks/3pjc6r7w9qxan.js","/_next/static/chunks/07t1rcdzji0vn.js","/_next/static/chunks/0ab2-46782ntx.js","/_next/static/chunks/3ex1ijq1gw1eb.js","/_next/static/chunks/27f80-sq8a9nm.js","/_next/static/chunks/21k90yd6lrzsc.js","/_next/static/chunks/00-5kse4g6azx.js","/_next/static/chunks/3giy7jirffwz9.js","/_next/static/chunks/2vsadn5_3a9ui.js","/_next/static/chunks/0bvim9_g0hu68.js","/_next/static/chunks/0gf5i4fmb2vxz.js","/_next/static/chunks/2bcd-9k-4fyab.js","/_next/static/chunks/18gle79tm4_vm.js","/_next/static/chunks/23c-cbn9bzzbb.js","/_next/static/chunks/1_lyn-lih218f.js","/_next/static/chunks/1c0w6764iswod.js","/_next/static/chunks/3d865g9_und-a.js","/_next/static/chunks/0tt83uyswwa6b.js","/_next/static/chunks/0czpc-f8wjri8.js","/_next/static/chunks/24_gg9g_4g22i.js","/_next/static/chunks/31pwnoicz230f.js","/_next/static/chunks/2dyt8rg18m736.js","/_next/static/chunks/312elt506g3__.js","/_next/static/chunks/3d3xbt99nfqun.js","/_next/static/chunks/2br2z5e4g144b.js","/_next/static/chunks/2pqhypz2vo8mu.js","/_next/static/chunks/2fz52lc6kg1s_.js","/_next/static/chunks/3x3-h1iyted1x.js","/_next/static/chunks/0fpx6rmsgi4um.js"],"PlaygroundContextProvider"] 4f:T9328,# Overview ## Description: Phi-4-multimodal-instruct is a lightweight open multimodal foundation model that leverages the language, vision, and speech research and datasets used for Phi-3.5 and 4.0 models. The model processes text, image, and audio inputs, generating text outputs, and comes with 128K token context length. The model underwent an enhancement process, incorporating both supervised fine-tuning, and direct preference optimization to support precise instruction adherence and safety measures. This model is ready for commercial/non-commercial use. ## Third-Party Community Consideration This model is not owned or developed by NVIDIA. This model has been developed and built to a third-party’s requirements for this application and use case; see link to Non-NVIDIA [Phi-4-Multimodal-Instruct](https://huggingface.co/microsoft/Phi-4-multimodal-instruct/blob/main/README.md). ### License/Terms of Use: GOVERNING TERMS: This trial service is governed by the [NVIDIA API Trial Terms of Service](https://assets.ngc.nvidia.com/products/api-catalog/legal/NVIDIA%20API%20Trial%20Terms%20of%20Service.pdf). Use of this model is governed by the [NVIDIA Community Model License](https://www.nvidia.com/en-us/agreements/enterprise-software/nvidia-community-models-license/). Additional Information: [MIT License](https://huggingface.co/microsoft/Phi-4-multimodal-instruct/blob/main/LICENSE). ### Deployment Geography: Global ### Release Date: February 2025 ## Reference(s): [Phi-4-Multimodal-Instruct Model Card](https://huggingface.co/microsoft/Phi-4-multimodal-instruct/blob/main/README.md) ## Intended Use ### Primary use cases: The model is intended for broad multilingual and multimodal commercial and research use. It provides uses for general purpose AI systems and applications which require memory/compute constrained environments, latency bound scenarios, strong reasoning, function and tool calling, general image understanding, optical character recognition, and chart and table understanding. The model is designed to accelerate research on language and multimodal models, for use as a building block for generative AI powered features. ### Out-of-scope use cases The model is not specifically designed or evaluated for all downstream purposes. Developers should consider common limitations of language models and multimodal models, as well as performance differences across languages, as they select use cases, and evaluate and mitigate for accuracy, safety, and fairness before using within a specific downstream use case, particularly for high-risk scenarios. Developers should be aware of and adhere to applicable laws or regulations (including but not limited to privacy, trade compliance laws, etc.) that are relevant to their use case. **Nothing contained in this Model Card should be interpreted as or deemed a restriction or modification to the license the model is released under.** ## Release Notes This release of Phi-4-multimodal-instruct is based on valuable user feedback from the Phi-3 series. Previously, users could use a speech recognition model to talk to the Mini and Vision models. To achieve this, users needed to use a pipeline of two models: one model to transcribe the audio to text, and another model for the language or vision tasks. This pipeline means that the core model was not provided the full breadth of input information – e.g. cannot directly observe multiple speakers, background noises, jointly align speech, vision, language information at the same time on the same representation space. With Phi-4-multimodal-instruct, a single new open model has been trained across text, vision, and audio, meaning that all inputs and outputs are processed by the same neural network. The model employed new architecture, larger vocabulary for efficiency, multilingual, and multimodal support, and better post-training techniques were used for instruction following and function calling, as well as additional data leading to substantial gains on key multimodal capabilities. It is anticipated that Phi-4-multimodal-instruct will greatly benefit app developers and various use cases. The enthusiastic support for the Phi-4 series is greatly appreciated. Feedback on Phi-4-multimodal-instruct is welcomed and crucial to the model’s evolution and improvement. Thank you for being part of this journey! ## Model Architecture: **Architecture Type:** Phi-4-multimodal-instruct has 5.6B parameters and is a multimodal transformer model. The model has the pretrained Phi-4-mini as the backbone language model, and the advanced encoders and adapters of vision and speech ## Input: **Input Type(s):** Text, Image, Audio
**Input Format(s):** String, [.png, .jpg, .jpeg], [.mp3, .wav]
**Input Parameters:** [1D, 2D]
**Other Properties Related to Input:** Languages in training data | Arabic, Chinese, Czech, Danish, Dutch, English, Finnish, French, German, Hebrew, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Thai, Turkish, Ukrainian
**Note that these are for TEXT only. There is limited language support for IMAGE and AUDIO modalities.**
* Vision: English
* Audio: English, Chinese, German, French, Italian, Japanese, Spanish, Portuguese
### Vision * Any common RGB/gray image format (e.g., (".jpg", ".jpeg", ".png", ".ppm", ".bmp", ".pgm", ".tif", ".tiff", ".webp")) can be supported. * Resolution depends on the GPU memory size. Higher resolution and more images will produce more tokens, thus using more GPU memory. During training, 64 crops can be supported. If it is a square image, the resolution would be around (8*448 by 8*448). For multiple-images, at most 64 frames can be supported, but with more frames as input, the resolution of each frame needs to be reduced to fit in the memory. ### Audio * Any audio format that can be loaded by soundfile package should be supported. * To keep the satisfactory performance, maximum audio length is suggested to be 40 seconds. For summarization tasks, the maximum audio length is suggested to 30 minutes. ## Output: **Output Type(s):** Text
**Output Format(s):** String
**Output Parameters:** 1D
**Supported Hardware Microarchitecture Compatibility:** * NVIDIA Ampere
* NVIDIA Hopper **[Preferred/Supported] Operating System(s):** * Linux ## Model Version(s): Phi-4-multimodal-instruct v1.0 ## Training, Testing, and Evaluation Datasets: **Data Collection Methods**: [Hybrid: Automated, Human, Synthetic]
**GPUS**: 512 A100-80G
**Training Time**: 28 days
**Training Data**: 5T text tokens, 2.3M speech hours, and 1.1T image-text token
**Training Dates**: Trained between December 2024 and January 2025
**Status**: This is a static model trained on offline datasets with the cutoff date of June 2024 for publicly available data.
**Languages in training data**: Arabic, Chinese, Czech, Danish, Dutch, English, Finnish, French, German, Hebrew, Hungarian, Italian, Japanese, Korean, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Thai, Turkish, Ukrainian
**Note that these are for TEXT only. There is limited language support for IMAGE and AUDIO modalities.
Vision: English
Audio: English, Chinese, German, French, Italian, Japanese, Spanish, Portuguese** ## Data Overview Phi-4-multimodal-instruct’s training data includes a wide variety of sources, totaling 5 trillion text tokens, and is a combination of: 1. Publicly available documents filtered for quality, selected high-quality educational data, and code 2. Newly created synthetic, “textbook-like” data for the purpose of teaching math, coding, common sense reasoning, general knowledge of the world (e.g., science, daily activities, theory of mind, etc.) 3. High quality human labeled data in chat format 4. Selected high-quality image-text interleave data 5. Synthetic and publicly available image, multi-image, and video data 6. Anonymized in-house speech-text pair data with strong/weak transcriptions 7. Selected high-quality publicly available and anonymized in-house speech data with task-specific supervisions 8. Selected synthetic speech data 9. Synthetic vision-speech data Focus was placed on the quality of data that could potentially improve the reasoning ability for the model, and the publicly available documents were filtered to contain a preferred level of knowledge. As an example, the result of a game in premier league on a particular day might be good training data for large foundation models, but such information was removed for the Phi-4-multimodal-instruct to leave more model capacity for reasoning for the model’s small size. The data collection process involved sourcing information from publicly available documents, with a focus on filtering out undesirable documents and images. To safeguard privacy, image and text data sources were filtered to remove or scrub potentially personal data from the training data. The decontamination process involved normalizing and tokenizing the dataset, then generating and comparing n-grams between the target dataset and benchmark datasets. Samples with matching n-grams above a threshold were flagged as contaminated and removed from the dataset. A detailed contamination report was generated, summarizing the matched text, matching ratio, and filtered results for further analysis. ## Safety ### Approach The Phi-4 family of models has adopted a robust safety post-training approach. This approach leverages a variety of both open-source and in-house generated datasets. The overall technique employed for safety alignment is a combination of SFT (Supervised Fine-Tuning), DPO (Direct Preference Optimization), and RLHF (Reinforcement Learning from Human Feedback) approaches by utilizing human-labeled and synthetic English-language datasets, including publicly available datasets focusing on helpfulness and harmlessness, as well as various questions and answers targeted to multiple safety categories. For non-English languages, existing datasets were extended via machine translation. Speech Safety datasets were generated by running Text Safety datasets through Azure TTS (Text-To-Speech) Service, for both English and non-English languages. Vision (text & images) Safety datasets were created to cover harm categories identified both in public and internal multi-modal RAI datasets. ### Safety Evaluation and Red-Teaming Various evaluation techniques including red teaming, adversarial conversation simulations, and multilingual safety evaluation benchmark datasets were leveraged to evaluate Phi-4 models’ propensity to produce undesirable outputs across multiple languages and risk categories. Several approaches were used to compensate for the limitations of one approach alone. Findings across the various evaluation methods indicate that safety post-training that was done as detailed in the Phi 3 Safety Post-Training paper had a positive impact across multiple languages and risk categories as observed by refusal rates (refusal to output undesirable outputs) and robustness to jailbreak techniques. Details on prior red team evaluations across Phi models can be found in the Phi 3 Safety Post-Training paper. For this release, the red teaming effort focused on the newest Audio input modality and on the following safety areas: harmful content, self-injury risks, and exploits. The model was found to be more susceptible to providing undesirable outputs when attacked with context manipulation or persuasive techniques. These findings applied to all languages, with the persuasive techniques mostly affecting French and Italian. This highlights the need for industry-wide investment in the development of high-quality safety evaluation datasets across multiple languages, including low resource languages, and risk areas that account for cultural nuances where those languages are spoken. ### Vision Safety Evaluation To assess model safety in scenarios involving both text and images, Microsoft’s Azure AI Evaluation SDK was utilized. This tool facilitates the simulation of single-turn conversations with the target model by providing prompt text and images designed to incite harmful responses. The target model's responses are subsequently evaluated by a capable model across multiple harm categories, including violence, sexual content, self-harm, hateful and unfair content, with each response scored based on the severity of the harm identified. The evaluation results were compared with those of Phi-3.5-Vision and open-source models of comparable size. In addition, we ran both an internal and the public RTVLM and VLGuard multi-modal (text & vision) RAI benchmarks, once again comparing scores with Phi-3.5-Vision and open-source models of comparable size. However, the model may be susceptible to language-specific attack prompts and cultural context. ### Audio Safety Evaluation In addition to extensive red teaming, the Safety of the model was assessed through three distinct evaluations. First, as performed with Text and Vision inputs, Microsoft’s Azure AI Evaluation SDK was leveraged to detect the presence of harmful content in the model’s responses to Speech prompts. Second, Microsoft’s Speech Fairness evaluation was run to verify that Speech-To-Text transcription worked well across a variety of demographics. Third, we proposed and evaluated a mitigation approach via a system message to help prevent the model from inferring sensitive attributes (such as gender, sexual orientation, profession, medical condition, etc...) from the voice of a user. ## Model Quality To understand the capabilities, Phi-4-multimodal-instruct was compared with a set of models over a variety of benchmarks using an internal benchmark platform. Users can refer to the Phi-4-Mini model card for details of language benchmarks. Below is a high-level overview of the model quality on representative speech and vision benchmarks: ### Speech Benchmarks Phi-4-multimodal-instruct demonstrated strong performance in speech tasks: - Surpassed expert ASR model WhisperV3 and ST models SeamlessM4T-v2-Large in automatic speech recognition (ASR) and speech translation (ST). - Ranked number 1 on the Huggingface OpenASR leaderboard with a word error rate of 6.14% compared to the current best model at 6.5% as of February 18, 2025. - First open-sourced model capable of performing speech summarization, with performance close to GPT4o. - Exhibited a gap with closed models like Gemini-2.0-Flash and GPT-4o-realtime-preview on the speech QA task. Efforts are ongoing to improve this capability in future iterations. ### Vision Benchmarks #### Vision-Speech Tasks Phi-4-multimodal-instruct can process both image and audio together. The table below shows the model quality when the input query for vision content is synthetic speech on chart/table understanding and document reasoning tasks. Compared to other state-of-the-art omni models, Phi-4-multimodal-instruct achieves stronger performance on multiple benchmarks. | Benchmarks | Phi-4-multimodal-instruct | InternOmni-7B | Gemini-2.0-Flash-Lite-prv-02-05 | Gemini-2.0-Flash | Gemini-1.5-Pro | |------------|----------------------------|---------------|---------------------------------|------------------|----------------| | s_AI2D | 68.9 | 53.9 | 62.0 | 69.4 | 67.7 | | s_ChartQA | 69.0 | 56.1 | 35.5 | 51.3 | 46.9 | | s_DocVQA | 87.3 | 79.9 | 76.0 | 80.3 | 78.2 | | s_InfoVQA | 63.7 | 60.3 | 59.4 | 63.6 | 66.1 | | **Average**| **72.2** | **62.6** | **58.2** | **66.2** | **64.7** | #### Vision Tasks To understand the vision capabilities, Phi-4-multimodal-instruct was compared with a set of models over a variety of zero-shot benchmarks using an internal benchmark platform. Below is a high-level overview of the model quality on representative benchmarks: | Dataset | Phi-4-multimodal-ins | Phi-3.5-vision-ins | Qwen 2.5-VL-3B-ins | Intern VL 2.5-4B | Qwen 2.5-VL-7B-ins | Intern VL 2.5-8B | Gemini 2.0-Flash Lite-prv-0205 | Gemini2.0-Flash | Claude-3.5-Sonnet-2024-10-22 | Gpt-4o-2024-11-20 | |------------------------------|----------------------|--------------------|--------------------|------------------|--------------------|------------------|---------------------------------|-----------------|--------------------------------|-------------------| | Popular aggregated benchmark | 55.1 | 43.0 | 47.0 | 48.3 | 51.8 | 50.6 | 54.1 | 64.7 | 55.8 | 61.7 | | MMBench (dev-en) | 86.7 | 81.9 | 84.3 | 86.8 | 87.8 | 88.2 | 85.0 | 90.0 | 86.7 | 89.0 | | MMMU-Pro (std / vision) | 38.5 | 21.8 | 29.9 | 32.4 | 38.7 | 34.4 | 45.1 | 54.4 | 54.3 | 53.0 | | ScienceQA Visual (img-test) | 97.5 | 91.3 | 79.4 | 96.2 | 87.7 | 97.3 | 85.0 | 88.3 | 81.2 | 88.2 | | MathVista (testmini) | 62.4 | 43.9 | 60.8 | 51.2 | 67.8 | 56.7 | 57.6 | 47.2 | 56.9 | 56.1 | | InterGPS | 48.6 | 36.3 | 48.3 | 53.7 | 52.7 | 54.1 | 57.9 | 65.4 | 47.1 | 49.1 | | AI2D | 82.3 | 78.1 | 78.4 | 80.0 | 82.6 | 83.0 | 77.6 | 82.1 | 70.6 | 83.8 | | ChartQA | 81.4 | 81.8 | 80.0 | 79.1 | 85.0 | 81.0 | 73.0 | 79.0 | 78.4 | 75.1 | | DocVQA | 93.2 | 69.3 | 93.9 | 91.6 | 95.7 | 93.0 | 91.2 | 92.1 | 95.2 | 90.9 | | InfoVQA | 72.7 | 36.6 | 77.1 | 72.1 | 82.6 | 77.6 | 73.0 | 77.8 | 74.3 | 71.9 | | TextVQA (val) | 75.6 | 72.0 | 76.8 | 70.9 | 77.7 | 74.8 | 72.9 | 74.4 | 58.6 | 73.1 | | OCR Bench | 84.4 | 63.8 | 82.2 | 71.6 | 87.7 | 74.8 | 75.7 | 81.0 | 77.0 | 77.7 | | POPE | 85.6 | 86.1 | 87.9 | 89.4 | 87.5 | 89.1 | 87.5 | 88.0 | 82.6 | 86.5 | | BLINK | 61.3 | 57.0 | 48.1 | 51.2 | 55.3 | 52.5 | 59.3 | 64.0 | 56.9 | 62.4 | | Video MME (16 frames) | 55.0 | 50.8 | 56.5 | 57.3 | 58.2 | 58.7 | 58.8 | 65.5 | 60.2 | 68.2 | | **Average** | **72.0** | **60.9** | **68.7** | **68.8** | **73.3** | **71.1** | **70.2** | **74.3** | **69.1** | **72.4** | Below are the comparison results on existing multi-image tasks. On average, Phi-4-multimodal-instruct outperforms competitor models of the same size and is competitive with much bigger models on multi-frame capabilities. BLINK is an aggregated benchmark with 14 visual tasks that humans can solve very quickly but are still hard for current multimodal LLMs. | Dataset | Phi-4-multimodal-instruct | Qwen2.5-VL-3B-Instruct | InternVL 2.5-4B | Qwen2.5-VL-7B-Instruct | InternVL 2.5-8B | Gemini-2.0-Flash-Lite-prv-02-05 | Gemini-2.0-Flash | Claude-3.5-Sonnet-2024-10-22 | Gpt-4o-2024-11-20 | |------------------------|---------------------------|------------------------|-----------------|------------------------|-----------------|---------------------------------|------------------|--------------------------------|-------------------| | Art Style | 86.3 | 58.1 | 59.8 | 65.0 | 65.0 | 76.9 | 76.9 | 68.4 | 73.5 | | Counting | 60.0 | 67.5 | 60.0 | 66.7 | 71.7 | 45.8 | 69.2 | 60.8 | 65.0 | | Forensic Detection | 90.2 | 34.8 | 22.0 | 43.9 | 37.9 | 31.8 | 74.2 | 63.6 | 71.2 | | Functional Correspondence | 30.0 | 20.0 | 26.9 | 22.3 | 27.7 | 48.5 | 53.1 | 34.6 | 42.3 | | IQ Test | 22.7 | 25.3 | 28.7 | 28.7 | 28.7 | 28.0 | 30.7 | 20.7 | 25.3 | | Jigsaw | 68.7 | 52.0 | 71.3 | 69.3 | 53.3 | 62.7 | 69.3 | 61.3 | 68.7 | | Multi-View Reasoning | 76.7 | 44.4 | 44.4 | 54.1 | 45.1 | 55.6 | 41.4 | 54.9 | 54.1 | | Object Localization | 52.5 | 55.7 | 53.3 | 55.7 | 58.2 | 63.9 | 67.2 | 58.2 | 65.6 | | Relative Depth | 69.4 | 68.5 | 68.5 | 80.6 | 76.6 | 81.5 | 72.6 | 66.1 | 73.4 | | Relative Reflectance | 26.9 | 38.8 | 38.8 | 32.8 | 38.8 | 33.6 | 34.3 | 38.1 | 38.1 | | Semantic Correspondence | 52.5 | 32.4 | 33.8 | 28.8 | 24.5 | 56.1 | 55.4 | 43.9 | 47.5 | | Spatial Relation | 72.7 | 80.4 | 86.0 | 88.8 | 86.7 | 74.1 | 79.0 | 74.8 | 83.2 | | Visual Correspondence | 67.4 | 28.5 | 39.5 | 50.0 | 44.2 | 84.9 | 91.3 | 72.7 | 82.6 | | Visual Similarity | 86.7 | 67.4 | 88.1 | 87.4 | 85.2 | 87.4 | 80.7 | 79.3 | 83.0 | | **Overall** | **61.3** | **48.1** | **51.2** | **55.3** | **52.5** | **59.3** | **64.0** | **56.9** | **62.4** | # Usage ### Input Format Given the nature of the training data, Phi-4-Multimodal-Instruct model is best suited for prompts using the chat format as follows: 1. **Text Chat Format** This format is used for general conversation and instructions: ``` <|system|>You are a helpful assistant.<|end|><|user|>How to explain Internet for a medieval knight?<|end|><|assistant|> ``` 1. **Tool-enabled Function Call Format for Text** This format is used when the user wants the model to provide function calls based on the given tools. The user should provide the available tools in the system prompt, wrapped by `<|tool|>` and `<|/tool|>` tokens. The tools should be specified in JSON format, using a JSON dump structure. For example: ``` <|system|>You are a helpful assistant with some tools.<|tool|> [{"name": "get_weather_updates", "description": "Fetches weather updates for a given city using the RapidAPI Weather API.", "parameters": {"city": {"description": "The name of the city for which to retrieve weather information.", "type": "str", "default": "London"}}}] <|/tool|><|end|><|user|>What is the weather like in Paris today?<|end|><|assistant|> ``` 1. **Vision-Language Format** This format is used for conversation with image: ``` <|user|><|image_1|>Describe the image in detail.<|end|><|assistant|> ``` For multiple images, the user needs to insert multiple image placeholders in the prompt as below: ``` <|user|><|image_1|><|image_2|><|image_3|>Summarize the content of the images.<|end|><|assistant|> ``` 1. **Speech-Language Format** This format is used for various speech and audio tasks: ``` <|user|><|audio_1|>{task prompt}<|end|><|assistant|> ``` The task prompt can vary for different task. * **Automatic Speech Recognition:** ``` <|user|><|audio_1|>Transcribe the audio clip into text.<|end|><|assistant|> ``` * **Automatic Speech Translation:** ``` <|user|><|audio_1|>Translate the audio to {lang}.<|end|><|assistant|> ``` * **Automatic Speech Translation with Chain-of-thought:** ``` <|user|><|audio_1|>Transcribe the audio to text, and then translate the audio to {lang}. Use as a separator between the original transcript and the translation.<|end|><|assistant|> ``` * **Spoken-query Question Answering:** ``` <|user|><|audio_1|><|end|><|assistant|> ``` 1. **Vision-Speech Format** This format is used for conversation with image and audio. The audio may contain query related to the image: ``` <|user|><|image_1|><|audio_1|><|end|><|assistant|> ``` For multiple images, the user needs to insert multiple image placeholders in the prompt as below: ``` <|user|><|image_1|><|image_2|><|image_3|><|audio_1|><|end|><|assistant|> ``` ### Vision * Any common RGB/gray image format (e.g., (".jpg", ".jpeg", ".png", ".ppm", ".bmp", ".pgm", ".tif", ".tiff", ".webp")) can be supported. * Resolution depends on the GPU memory size. Higher resolution and more images will produce more tokens, thus using more GPU memory. During training, 64 crops can be supported. If it is a square image, the resolution would be around (8*448 by 8*448). For multiple-images, at most 64 frames can be supported, but with more frames as input, the resolution of each frame needs to be reduced to fit in the memory. ### Audio * Any audio format that can be loaded by soundfile package should be supported. * To keep the satisfactory performance, maximum audio length is suggested to be 40 seconds. For summarization tasks, the maximum audio length is suggested to 30 minutes. ### Loading the Model Locally After obtaining the Phi-4-Multimodal-Instruct model checkpoints, users can use this sample code for inference. ```python import requests import torch import os from PIL import Image import soundfile from transformers import AutoModelForCausalLM, AutoProcessor, GenerationConfig,pipeline,AutoTokenizer processor = AutoProcessor.from_pretrained(model_path, trust_remote_code=True) model = AutoModelForCausalLM.from_pretrained( "microsoft/Phi-4-Multimodal-Instruct", device_map="cuda", torch_dtype="auto", trust_remote_code=True, _attn_implementation='flash_attention_2', ).cuda() generation_config = GenerationConfig.from_pretrained(model_path, 'generation_config.json') user_prompt = '<|user|>' assistant_prompt = '<|assistant|>' prompt_suffix = '<|end|>' prompt = f'{user_prompt}<|image_1|>What is shown in this image?{prompt_suffix}{assistant_prompt}' url = 'https://www.ilankelman.org/stopsigns/australia.jpg' print(f'>>> Prompt\n{prompt}') image = Image.open(requests.get(url, stream=True).raw) inputs = processor(text=prompt, images=image, return_tensors='pt').to('cuda:0') generate_ids = model.generate( **inputs, max_new_tokens=1000, generation_config=generation_config, ) generate_ids = generate_ids[:, inputs['input_ids'].shape[1] :] response = processor.batch_decode( generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False )[0] print(f'>>> Response\n{response}') speech_prompt = "Transcribe the audio to text, and then translate the audio to French. Use as a separator between the original transcript and the translation." prompt = f'{user_prompt}<|audio_1|>{speech_prompt}{prompt_suffix}{assistant_prompt}' print(f'>>> Prompt\n{prompt}') audio = soundfile.read('https://voiceage.com/wbsamples/in_mono/Trailer.wav') inputs = processor(text=prompt, audios=[audio], return_tensors='pt').to('cuda:0') generate_ids = model.generate( **inputs, max_new_tokens=1000, generation_config=generation_config, ) generate_ids = generate_ids[:, inputs['input_ids'].shape[1] :] response = processor.batch_decode( generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False )[0] print(f'>>> Response\n{response}') ``` ## Inference: **Engine:** vLLM
**Test Hardware:** NVIDIA H100 ## Responsible AI Considerations Like other language models, the Phi family of models can potentially behave in ways that are unfair, unreliable, or offensive. Some of the limiting behaviors to be aware of include: - **Quality of Service:** The Phi models are trained primarily on English language content across text, speech, and visual inputs, with some additional multilingual coverage. Performance may vary significantly across different modalities and languages: - **Text:** Languages other than English will experience reduced performance, with varying levels of degradation across different non-English languages. English language varieties with less representation in the training data may perform worse than standard American English. - **Speech:** Speech recognition and processing shows similar language-based performance patterns, with optimal performance for standard American English accents and pronunciations. Other English accents, dialects, and non-English languages may experience lower recognition accuracy and response quality. Background noise, audio quality, and speaking speed can further impact performance. - **Vision:** Visual processing capabilities may be influenced by cultural and geographical biases in the training data. The model may show reduced performance when analyzing images containing text in non-English languages or visual elements more commonly found in non-Western contexts. Image quality, lighting conditions, and composition can also affect processing accuracy. - **Multilingual performance and safety gaps:** We believe it is important to make language models more widely available across different languages, but the Phi 4 models still exhibit challenges common across multilingual releases. As with any deployment of LLMs, developers will be better positioned to test for performance or safety gaps for their linguistic and cultural context and customize the model with additional fine-tuning and appropriate safeguards. - **Representation of Harms & Perpetuation of Stereotypes:** These models can over- or under-represent groups of people, erase representation of some groups, or reinforce demeaning or negative stereotypes. Despite safety post-training, these limitations may still be present due to differing levels of representation of different groups, cultural contexts, or prevalence of examples of negative stereotypes in training data that reflect real-world patterns and societal biases. - **Inappropriate or Offensive Content:** These models may produce other types of inappropriate or offensive content, which may make it inappropriate to deploy for sensitive contexts without additional mitigations that are specific to the case. - **Information Reliability:** Language models can generate nonsensical content or fabricate content that might sound reasonable but is inaccurate or outdated. - **Limited Scope for Code:** The majority of Phi 4 training data is based in Python and uses common packages such as "typing, math, random, collections, datetime, itertools". If the model generates Python scripts that utilize other packages or scripts in other languages, it is strongly recommended that users manually verify all API uses. - **Long Conversation:** Phi 4 models, like other models, can in some cases generate responses that are repetitive, unhelpful, or inconsistent in very long chat sessions in both English and non-English languages. Developers are encouraged to place appropriate mitigations, like limiting conversation turns to account for the possible conversational drift. Developers should apply responsible AI best practices, including mapping, measuring, and mitigating risks associated with their specific use case and cultural, linguistic context. Phi 4 family of models are general purpose models. As developers plan to deploy these models for specific use cases, they are encouraged to fine-tune the models for their use case and leverage the models as part of broader AI systems with language-specific safeguards in place. Important areas for consideration include: - **Allocation:** Models may not be suitable for scenarios that could have consequential impact on legal status or the allocation of resources or life opportunities (ex: housing, employment, credit, etc.) without further assessments and additional debiasing techniques. - **High-Risk Scenarios:** Developers should assess the suitability of using models in high-risk scenarios where unfair, unreliable or offensive outputs might be extremely costly or lead to harm. This includes providing advice in sensitive or expert domains where accuracy and reliability are critical (ex: legal or health advice). Additional safeguards should be implemented at the application level according to the deployment context. - **Misinformation:** Models may produce inaccurate information. Developers should follow transparency best practices and inform end-users they are interacting with an AI system. At the application level, developers can build feedback mechanisms and pipelines to ground responses in use-case specific, contextual information, a technique known as Retrieval Augmented Generation (RAG). - **Generation of Harmful Content:** Developers should assess outputs for their context and use available safety classifiers or custom solutions appropriate for their use case. - **Misuse:** Other forms of misuse such as fraud, spam, or malware production may be possible, and developers should ensure that their applications do not violate applicable laws and regulations. ## Ethical Considerations: Ethical considerations and guidelines. NVIDIA believes Trustworthy AI is a shared responsibility and we have established policies and practices to enable development for a wide array of AI applications. When downloaded or used in accordance with our terms of service, developers should work with their internal model team to ensure this model meets requirements for the relevant industry and use case and addresses unforeseen product misuse. Please report security vulnerabilities or NVIDIA AI Concerns [here](https://www.nvidia.com/en-us/support/submit-security-vulnerability/).50:T1daa,<% // Catalog ejs locals replace JSON with {stringify} only (spread skips non-enumerable parse). const deepClone = (value) => { if (Array.isArray(value)) return value.map(deepClone); if (value && typeof value === "object") { const out = {}; for (const key of Object.keys(value)) out[key] = deepClone(value[key]); return out; } return value; }; const mediaConfig = {"image": {"mimeTypes": {".png": "image/png", ".jpg": "image/jpeg", ".jpeg": "image/jpeg", ".webp": "image/webp"}}, "video": {"mimeTypes": {}}, "audio": {"mimeTypes": {".wav": "audio/wav", ".mp3": "audio/mpeg"}, "defaultFormat": "wav"}}; const stripNulls = (value) => { if (Array.isArray(value)) return value.map(stripNulls); if (value && typeof value === "object") { const out = {}; for (const [key, item] of Object.entries(value)) { if (item === null || item === undefined) continue; out[key] = stripNulls(item); } return out; } return value; }; const payloadForSnippet = stripNulls(deepClone(request || {})); const hasStream = payloadForSnippet.stream !== undefined && payloadForSnippet.stream !== null; const pyStream = payloadForSnippet.stream ? "True" : "False"; if (hasStream) payloadForSnippet.stream = "__STREAM__"; const hasMediaKind = (kind) => Object.keys(mediaConfig[kind].mimeTypes || {}).length > 0; const isInlineDataUrl = (url, kind) => ( typeof url === "string" && new RegExp(`^data:${kind}/[^;]+;base64,`, "i").test(url) ); const mediaUrl = (part, key) => { const slot = part?.[key]; return typeof slot === "string" ? slot : slot?.url; }; const setMediaUrl = (part, key, url) => { if (typeof part[key] === "string") part[key] = url; else { if (!part[key] || typeof part[key] !== "object") part[key] = {}; part[key].url = url; } }; let imageCount = 0; let videoCount = 0; let audioCount = 0; (payloadForSnippet.messages || []).forEach((message) => { if (!Array.isArray(message?.content)) return; message.content.forEach((part) => { const imageUrl = mediaUrl(part, "image_url"); const videoUrl = mediaUrl(part, "video_url"); const audioUrl = mediaUrl(part, "audio_url"); // File helpers only for inline base64; http(s) URLs stay as-is in the payload. if (hasMediaKind("image") && part?.type === "image_url" && isInlineDataUrl(imageUrl, "image")) { setMediaUrl(part, "image_url", `__IMAGE_DATA_URL_${imageCount}__`); imageCount += 1; } else if (hasMediaKind("video") && part?.type === "video_url" && isInlineDataUrl(videoUrl, "video")) { setMediaUrl(part, "video_url", `__VIDEO_DATA_URL_${videoCount}__`); videoCount += 1; } else if (hasMediaKind("audio") && part?.type === "audio_url" && isInlineDataUrl(audioUrl, "audio")) { setMediaUrl(part, "audio_url", `__AUDIO_DATA_URL_${audioCount}__`); audioCount += 1; } else if (hasMediaKind("audio") && part?.type === "input_audio" && part.input_audio?.data) { part.input_audio.data = `__AUDIO_B64_${audioCount}__`; part.input_audio.format = part.input_audio.format || mediaConfig.audio.defaultFormat; audioCount += 1; } }); }); const pyRepr = (value, level = 0) => { if (value === null) return "None"; if (typeof value === "boolean") return value ? "True" : "False"; if (typeof value === "number") return String(value); if (typeof value === "string") return JSON.stringify(value); const pad = " ".repeat(level); const innerPad = " ".repeat(level + 2); if (Array.isArray(value)) { if (value.length === 0) return "[]"; return "[\n" + value.map((item) => `${innerPad}${pyRepr(item, level + 2)}`).join(",\n") + "\n" + pad + "]"; } if (typeof value === "object") { const entries = Object.entries(value); if (entries.length === 0) return "{}"; return "{\n" + entries.map(([key, item]) => `${innerPad}${JSON.stringify(key)}: ${pyRepr(item, level + 2)}`).join(",\n") + "\n" + pad + "}"; } return "None"; }; const replaceAll = (s, a, b) => s.split(a).join(b); let renderedPayload = pyRepr(payloadForSnippet); if (hasStream) renderedPayload = replaceAll(renderedPayload, '"__STREAM__"', "stream"); for (let i = 0; i < imageCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__IMAGE_DATA_URL_${i}__"`, `image_data_urls[${i}]`); } for (let i = 0; i < videoCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__VIDEO_DATA_URL_${i}__"`, `video_data_urls[${i}]`); } for (let i = 0; i < audioCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__AUDIO_DATA_URL_${i}__"`, `audio_data_urls[${i}]`); renderedPayload = replaceAll(renderedPayload, `"__AUDIO_B64_${i}__"`, `audio_b64s[${i}]`); } // Either file helpers XOR inline base64 - never emit unused helpers. const usesFileHelpers = imageCount + videoCount + audioCount > 0 && [...Array(imageCount).keys()].every((i) => renderedPayload.includes(`image_data_urls[${i}]`)) && [...Array(videoCount).keys()].every((i) => renderedPayload.includes(`video_data_urls[${i}]`)) && [...Array(audioCount).keys()].every( (i) => renderedPayload.includes(`audio_data_urls[${i}]`) || renderedPayload.includes(`audio_b64s[${i}]`) ); if (!usesFileHelpers) { imageCount = 0; videoCount = 0; audioCount = 0; const restored = stripNulls(deepClone(request || {})); const restoredStream = restored.stream !== undefined && restored.stream !== null; if (restoredStream) restored.stream = "__STREAM__"; renderedPayload = pyRepr(restored); if (restoredStream) renderedPayload = replaceAll(renderedPayload, '"__STREAM__"', "stream"); } const hasMedia = usesFileHelpers; const mimePy = (mimes) => "{" + Object.entries(mimes).map(([k, v]) => `${JSON.stringify(k)}: ${JSON.stringify(v)}`).join(", ") + "}"; %> <% if (hasMedia) { %>import base64 from pathlib import Path <% } %>import requests invoke_url = "https://integrate.api.nvidia.com/v1/chat/completions" stream = <%- pyStream %> <% if (hasMedia) { %> def media_data_url(kind, index, mime_types): for suffix, mime in mime_types.items(): path = Path(f"{kind}_{index}{suffix}") if path.exists(): return f"data:{mime};base64,{base64.b64encode(path.read_bytes()).decode()}" raise FileNotFoundError(f"Expected {kind}_{index} with suffix in {list(mime_types)}") <% if (imageCount > 0) { %> image_data_urls = [media_data_url("image", i, <%- mimePy(mediaConfig.image.mimeTypes) %>) for i in <%- imageCount === 1 ? "[1]" : ("range(1, " + (imageCount + 1) + ")") %>] <% } %><% if (videoCount > 0) { %> video_data_urls = [media_data_url("video", i, <%- mimePy(mediaConfig.video.mimeTypes) %>) for i in <%- videoCount === 1 ? "[1]" : ("range(1, " + (videoCount + 1) + ")") %>] <% } %><% if (audioCount > 0) { %> audio_data_urls = [media_data_url("audio", i, <%- mimePy(mediaConfig.audio.mimeTypes) %>) for i in <%- audioCount === 1 ? "[1]" : ("range(1, " + (audioCount + 1) + ")") %>] audio_b64s = [url.split(",", 1)[1] for url in audio_data_urls] <% } %><% } %> headers = { "Authorization": "Bearer $NVIDIA_API_KEY", "Accept": "text/event-stream" if stream else "application/json", } payload = <%- renderedPayload %> response = requests.post(invoke_url, headers=headers, json=payload, stream=stream) if stream: for line in response.iter_lines(): if line: print(line.decode("utf-8")) else: print(response.json()) 51:T16c7,<% const deepClone = (value) => { if (Array.isArray(value)) return value.map(deepClone); if (value && typeof value === "object") { const out = {}; for (const key of Object.keys(value)) out[key] = deepClone(value[key]); return out; } return value; }; const mediaConfig = {"image": {"mimeTypes": {".png": "image/png", ".jpg": "image/jpeg", ".jpeg": "image/jpeg", ".webp": "image/webp"}}, "video": {"mimeTypes": {}}, "audio": {"mimeTypes": {".wav": "audio/wav", ".mp3": "audio/mpeg"}, "defaultFormat": "wav"}}; const payloadForSnippet = deepClone(request || {}); const messagesForSnippet = deepClone(payloadForSnippet.messages || []); const hasMediaKind = (kind) => Object.keys(mediaConfig[kind].mimeTypes || {}).length > 0; const isInlineDataUrl = (url, kind) => ( typeof url === "string" && new RegExp(`^data:${kind}/[^;]+;base64,`, "i").test(url) ); const mediaUrl = (part, key) => { const slot = part?.[key]; return typeof slot === "string" ? slot : slot?.url; }; const setMediaUrl = (part, key, url) => { if (typeof part[key] === "string") part[key] = url; else { if (!part[key] || typeof part[key] !== "object") part[key] = {}; part[key].url = url; } }; let imageCount = 0; let hasUnsupportedMedia = false; messagesForSnippet.forEach((message) => { if (!Array.isArray(message?.content)) return; message.content.forEach((part) => { const imageUrl = mediaUrl(part, "image_url"); if (hasMediaKind("image") && part?.type === "image_url" && isInlineDataUrl(imageUrl, "image")) { setMediaUrl(part, "image_url", `__IMAGE_DATA_URL_${imageCount}__`); imageCount += 1; } else if (part?.type === "video_url" && isInlineDataUrl(mediaUrl(part, "video_url"), "video")) { // LangChain cannot ship local file helpers for video; reject inline only. hasUnsupportedMedia = true; setMediaUrl(part, "video_url", "__UNSUPPORTED_MEDIA_DATA__"); } else if (part?.type === "audio_url" && isInlineDataUrl(mediaUrl(part, "audio_url"), "audio")) { hasUnsupportedMedia = true; setMediaUrl(part, "audio_url", "__UNSUPPORTED_MEDIA_DATA__"); } else if (part?.type === "input_audio" && part.input_audio?.data) { hasUnsupportedMedia = true; part.input_audio.data = "__UNSUPPORTED_MEDIA_DATA__"; } }); }); const pyRepr = (value, level = 0) => { if (value === null) return "None"; if (typeof value === "boolean") return value ? "True" : "False"; if (typeof value === "number") return String(value); if (typeof value === "string") return JSON.stringify(value); const pad = " ".repeat(level); const innerPad = " ".repeat(level + 2); if (Array.isArray(value)) { if (value.length === 0) return "[]"; return "[\n" + value.map((item) => `${innerPad}${pyRepr(item, level + 2)},`).join("\n") + "\n" + pad + "]"; } if (typeof value === "object") { const entries = Object.entries(value); if (entries.length === 0) return "{}"; return "{\n" + entries.map(([key, item]) => `${innerPad}${JSON.stringify(key)}: ${pyRepr(item, level + 2)},`).join("\n") + "\n" + pad + "}"; } return "None"; }; const replaceAll = (s, a, b) => s.split(a).join(b); let renderedMessages = pyRepr(messagesForSnippet); for (let i = 0; i < imageCount; i++) { renderedMessages = replaceAll(renderedMessages, `"__IMAGE_DATA_URL_${i}__"`, `image_data_urls[${i}]`); } // Either file helpers XOR inline base64 - never emit unused helpers. const usesFileHelpers = imageCount > 0 && [...Array(imageCount).keys()].every((i) => renderedMessages.includes(`image_data_urls[${i}]`)); if (!usesFileHelpers) { imageCount = 0; renderedMessages = pyRepr(deepClone((request || {}).messages || [])); } %> from langchain_nvidia_ai_endpoints import ChatNVIDIA <% if (imageCount > 0) { %>from pathlib import Path import base64 <% } %> client = ChatNVIDIA( model="<%- request.model %>", api_key="$NVIDIA_API_KEY", temperature=<%- request.temperature %>, top_p=<%- request.top_p %>, max_completion_tokens=<%- request.max_tokens %>, ) <% if (imageCount > 0) { %> def find_image_path(index): image_mime_types = <%- pyRepr(mediaConfig.image.mimeTypes) %> for suffix in image_mime_types: path = Path(f"image_{index}{suffix}") if path.exists(): return path expected = "/".join(f".{suffix.lstrip('.')}" for suffix in image_mime_types) raise FileNotFoundError(f"Expected image_{index}{expected}") def read_image_data_url(path): image_mime_types = <%- pyRepr(mediaConfig.image.mimeTypes) %> with open(path, "rb") as f: image_b64 = base64.b64encode(f.read()).decode() return f"data:{image_mime_types[path.suffix.lower()]};base64,{image_b64}" image_data_urls = [read_image_data_url(find_image_path(i)) for i in range(1, <%- imageCount + 1 %>)] <% } %><% if (hasUnsupportedMedia) { %> raise ValueError("LangChain snippet currently supports text and image input. Use Python, Node.js, or Shell for video or audio input.") <% } %> lc_messages = <%- renderedMessages %> <% if (request.stream) { %> for chunk in client.stream(lc_messages<%= request.chat_template_kwargs ? ', chat_template_kwargs=' + pyRepr(request.chat_template_kwargs) : '' %>): if chunk.additional_kwargs and "reasoning_content" in chunk.additional_kwargs: print(chunk.additional_kwargs["reasoning_content"], end="") print(chunk.content, end="") <% } else { %> response = client.invoke(lc_messages<%= request.chat_template_kwargs ? ', chat_template_kwargs=' + pyRepr(request.chat_template_kwargs) : '' %>) if response.additional_kwargs and "reasoning_content" in response.additional_kwargs: print(response.additional_kwargs["reasoning_content"]) print(response.content) <% } %> 52:T1b06,<% const deepClone = (value) => { if (Array.isArray(value)) return value.map(deepClone); if (value && typeof value === "object") { const out = {}; for (const key of Object.keys(value)) out[key] = deepClone(value[key]); return out; } return value; }; const mediaConfig = {"image": {"mimeTypes": {".png": "image/png", ".jpg": "image/jpeg", ".jpeg": "image/jpeg", ".webp": "image/webp"}}, "video": {"mimeTypes": {}}, "audio": {"mimeTypes": {".wav": "audio/wav", ".mp3": "audio/mpeg"}, "defaultFormat": "wav"}}; const payloadForSnippet = deepClone(request || {}); const hasStream = payloadForSnippet.stream !== undefined && payloadForSnippet.stream !== null; if (hasStream) payloadForSnippet.stream = "__STREAM__"; const hasMediaKind = (kind) => Object.keys(mediaConfig[kind].mimeTypes || {}).length > 0; const isInlineDataUrl = (url, kind) => ( typeof url === "string" && new RegExp(`^data:${kind}/[^;]+;base64,`, "i").test(url) ); let imageCount = 0; let videoCount = 0; let audioCount = 0; (payloadForSnippet.messages || []).forEach((message) => { if (!Array.isArray(message?.content)) return; message.content.forEach((part) => { if (hasMediaKind("image") && part?.type === "image_url" && isInlineDataUrl(part.image_url?.url, "image")) { part.image_url.url = `__IMAGE_DATA_URL_${imageCount}__`; imageCount += 1; } else if (hasMediaKind("video") && part?.type === "video_url" && isInlineDataUrl(part.video_url?.url, "video")) { part.video_url.url = `__VIDEO_DATA_URL_${videoCount}__`; videoCount += 1; } else if (hasMediaKind("audio") && part?.type === "audio_url" && isInlineDataUrl(part.audio_url?.url, "audio")) { part.audio_url.url = `__AUDIO_DATA_URL_${audioCount}__`; audioCount += 1; } else if (hasMediaKind("audio") && part?.type === "input_audio" && part.input_audio?.data) { part.input_audio.data = `__AUDIO_B64_${audioCount}__`; part.input_audio.format = part.input_audio.format || mediaConfig.audio.defaultFormat; audioCount += 1; } }); }); const replaceAll = (s, a, b) => s.split(a).join(b); let renderedPayload = JSON.stringify(payloadForSnippet, null, 2); if (hasStream) renderedPayload = replaceAll(renderedPayload, '"__STREAM__"', "stream"); for (let i = 0; i < imageCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__IMAGE_DATA_URL_${i}__"`, `imageDataUrls[${i}]`); } for (let i = 0; i < videoCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__VIDEO_DATA_URL_${i}__"`, `videoDataUrls[${i}]`); } for (let i = 0; i < audioCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__AUDIO_DATA_URL_${i}__"`, `audioDataUrls[${i}]`); renderedPayload = replaceAll(renderedPayload, `"__AUDIO_B64_${i}__"`, `audioB64s[${i}]`); } // Either file helpers XOR inline base64 - never emit unused helpers. const usesFileHelpers = imageCount + videoCount + audioCount > 0 && [...Array(imageCount).keys()].every((i) => renderedPayload.includes(`imageDataUrls[${i}]`)) && [...Array(videoCount).keys()].every((i) => renderedPayload.includes(`videoDataUrls[${i}]`)) && [...Array(audioCount).keys()].every( (i) => renderedPayload.includes(`audioDataUrls[${i}]`) || renderedPayload.includes(`audioB64s[${i}]`) ); if (!usesFileHelpers) { imageCount = 0; videoCount = 0; audioCount = 0; const restored = deepClone(request || {}); const restoredStream = restored.stream !== undefined && restored.stream !== null; if (restoredStream) restored.stream = "__STREAM__"; renderedPayload = JSON.stringify(restored, null, 2); if (restoredStream) renderedPayload = replaceAll(renderedPayload, '"__STREAM__"', "stream"); } const hasMedia = usesFileHelpers; %> import axios from 'axios'; <% if (hasMedia) { %>import { existsSync } from 'node:fs'; import { readFile } from 'node:fs/promises'; import { extname } from 'node:path'; <% } %> const invokeUrl = "https://integrate.api.nvidia.com/v1/chat/completions"; const stream = <%- request.stream %>; const headers = { "Authorization": "Bearer $NVIDIA_API_KEY", "Accept": stream ? "text/event-stream" : "application/json" }; <% if (hasMedia) { %> function findMediaPath(kind, index, mimeTypes) { for (const suffix of Object.keys(mimeTypes)) { const path = `${kind}_${index}${suffix}`; if (existsSync(path)) { return path; } } const expected = Object.keys(mimeTypes).join("/"); throw new Error(`Expected ${kind}_${index}${expected}`); } async function readMediaB64(path) { return Buffer.from(await readFile(path)).toString('base64'); } function mediaDataUrl(path, mediaB64, mimeTypes) { return `data:${mimeTypes[extname(path).toLowerCase()]};base64,${mediaB64}`; } <% } %> async function main() { <% if (imageCount > 0) { %> const imageMimeTypes = <%- JSON.stringify(mediaConfig.image.mimeTypes, null, 2) %>; const imagePaths = [<% for (let i = 1; i <= imageCount; i++) { %>findMediaPath("image", <%- i %>, imageMimeTypes)<%- i < imageCount ? ", " : "" %><% } %>]; const imageB64s = await Promise.all(imagePaths.map(readMediaB64)); const imageDataUrls = imagePaths.map((path, index) => mediaDataUrl(path, imageB64s[index], imageMimeTypes)); <% } %><% if (videoCount > 0) { %> const videoMimeTypes = <%- JSON.stringify(mediaConfig.video.mimeTypes, null, 2) %>; const videoPaths = [<% for (let i = 1; i <= videoCount; i++) { %>findMediaPath("video", <%- i %>, videoMimeTypes)<%- i < videoCount ? ", " : "" %><% } %>]; const videoB64s = await Promise.all(videoPaths.map(readMediaB64)); const videoDataUrls = videoPaths.map((path, index) => mediaDataUrl(path, videoB64s[index], videoMimeTypes)); <% } %><% if (audioCount > 0) { %> const audioMimeTypes = <%- JSON.stringify(mediaConfig.audio.mimeTypes, null, 2) %>; const audioPaths = [<% for (let i = 1; i <= audioCount; i++) { %>findMediaPath("audio", <%- i %>, audioMimeTypes)<%- i < audioCount ? ", " : "" %><% } %>]; const audioB64s = await Promise.all(audioPaths.map(readMediaB64)); const audioDataUrls = audioPaths.map((path, index) => mediaDataUrl(path, audioB64s[index], audioMimeTypes)); <% } %> const payload = <%- renderedPayload %>; const response = await axios.post(invokeUrl, payload, { headers: headers, responseType: stream ? 'stream' : 'json' }); if (stream) { response.data.on('data', (chunk) => { console.log(chunk.toString()); }); } else { console.log(JSON.stringify(response.data)); } } main().catch(error => { if (error.response) { console.error(`HTTP ${error.response.status}`); if (error.response.data?.on) { error.response.data.on('data', (chunk) => console.error(chunk.toString())); } else { console.error(error.response.data); } } else { console.error(error); } }); 53:T15bd,<% const deepClone = (value) => { if (Array.isArray(value)) return value.map(deepClone); if (value && typeof value === "object") { const out = {}; for (const key of Object.keys(value)) out[key] = deepClone(value[key]); return out; } return value; }; const mediaConfig = {"image": {"mimeTypes": {".png": "image/png", ".jpg": "image/jpeg", ".jpeg": "image/jpeg", ".webp": "image/webp"}}, "video": {"mimeTypes": {}}, "audio": {"mimeTypes": {".wav": "audio/wav", ".mp3": "audio/mpeg"}, "defaultFormat": "wav"}}; const payloadForSnippet = deepClone(request || {}); const hasMediaKind = (kind) => Object.keys(mediaConfig[kind].mimeTypes || {}).length > 0; const isInlineDataUrl = (url, kind) => ( typeof url === "string" && new RegExp(`^data:${kind}/[^;]+;base64,`, "i").test(url) ); let imageCount = 0; let videoCount = 0; let audioCount = 0; (payloadForSnippet.messages || []).forEach((message) => { if (!Array.isArray(message?.content)) return; message.content.forEach((part) => { if (hasMediaKind("image") && part?.type === "image_url" && isInlineDataUrl(part.image_url?.url, "image")) { part.image_url.url = `__IMAGE_DATA_URL_${imageCount}__`; imageCount += 1; } else if (hasMediaKind("video") && part?.type === "video_url" && isInlineDataUrl(part.video_url?.url, "video")) { part.video_url.url = `__VIDEO_DATA_URL_${videoCount}__`; videoCount += 1; } else if (hasMediaKind("audio") && part?.type === "audio_url" && isInlineDataUrl(part.audio_url?.url, "audio")) { part.audio_url.url = `__AUDIO_DATA_URL_${audioCount}__`; audioCount += 1; } else if (hasMediaKind("audio") && part?.type === "input_audio" && part.input_audio?.data) { part.input_audio.data = `__AUDIO_B64_${audioCount}__`; part.input_audio.format = part.input_audio.format || mediaConfig.audio.defaultFormat; audioCount += 1; } }); }); const replaceAll = (s, a, b) => s.split(a).join(b); let renderedPayload = JSON.stringify(payloadForSnippet, null, 2); for (let i = 0; i < imageCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__IMAGE_DATA_URL_${i}__"`, `"${"${"}image_${i + 1}_data_url}"`); } for (let i = 0; i < videoCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__VIDEO_DATA_URL_${i}__"`, `"${"${"}video_${i + 1}_data_url}"`); } for (let i = 0; i < audioCount; i++) { renderedPayload = replaceAll(renderedPayload, `"__AUDIO_DATA_URL_${i}__"`, `"${"${"}audio_${i + 1}_data_url}"`); renderedPayload = replaceAll(renderedPayload, `"__AUDIO_B64_${i}__"`, `"${"${"}audio_${i + 1}_b64}"`); } // Either file helpers XOR inline base64 - never emit unused helpers. const usesFileHelpers = imageCount + videoCount + audioCount > 0 && [...Array(imageCount).keys()].every((i) => renderedPayload.includes(`image_${i + 1}_data_url`)) && [...Array(videoCount).keys()].every((i) => renderedPayload.includes(`video_${i + 1}_data_url`)) && [...Array(audioCount).keys()].every( (i) => renderedPayload.includes(`audio_${i + 1}_data_url`) || renderedPayload.includes(`audio_${i + 1}_b64`) ); if (!usesFileHelpers) { imageCount = 0; videoCount = 0; audioCount = 0; renderedPayload = JSON.stringify(deepClone(request || {}), null, 2); } const hasMedia = usesFileHelpers; %> stream=<%- request.stream %> if [ "$stream" = true ]; then accept_header='Accept: text/event-stream' else accept_header='Accept: application/json' fi <% if (hasMedia) { %> mime_type_for() { case "$1" in <% for (const [suffix, mimeType] of Object.entries({...mediaConfig.image.mimeTypes, ...mediaConfig.video.mimeTypes, ...mediaConfig.audio.mimeTypes})) { %> *<%- suffix %>) echo "<%- mimeType %>" ;; <% } %> *) echo "Unsupported media file: $1" >&2; return 1 ;; esac } find_media_path() { local kind="$1" local index="$2" shift 2 local ext path for ext in "$@"; do path="${kind}_${index}.${ext}" if [ -f "$path" ]; then echo "$path" return 0 fi done echo "Expected ${kind}_${index}.$*" >&2 return 1 } media_b64() { base64 < "$1" | tr -d '\n' } media_data_url() { local path="$1" local mime_type media_base64 mime_type=$(mime_type_for "$path") || return 1 media_base64=$(media_b64 "$path") || return 1 printf 'data:%s;base64,%s' "$mime_type" "$media_base64" } <% for (let i = 1; i <= imageCount; i++) { %> image_<%- i %>_path=$(find_media_path image <%- i %><% for (const suffix of Object.keys(mediaConfig.image.mimeTypes)) { %> <%- suffix.slice(1) %><% } %>) image_<%- i %>_data_url=$(media_data_url "$image_<%- i %>_path") <% } %><% for (let i = 1; i <= videoCount; i++) { %> video_<%- i %>_path=$(find_media_path video <%- i %><% for (const suffix of Object.keys(mediaConfig.video.mimeTypes)) { %> <%- suffix.slice(1) %><% } %>) video_<%- i %>_data_url=$(media_data_url "$video_<%- i %>_path") <% } %><% for (let i = 1; i <= audioCount; i++) { %> audio_<%- i %>_path=$(find_media_path audio <%- i %><% for (const suffix of Object.keys(mediaConfig.audio.mimeTypes)) { %> <%- suffix.slice(1) %><% } %>) audio_<%- i %>_b64=$(media_b64 "$audio_<%- i %>_path") audio_<%- i %>_data_url=$(media_data_url "$audio_<%- i %>_path") <% } %><% } %> cat > payload.json < JSON curl https://integrate.api.nvidia.com/v1/chat/completions \ -H "Authorization: Bearer $NVIDIA_API_KEY" \ -H "Content-Type: application/json" \ -H "$accept_header" \ -d @payload.json4d:["$","$L4e",null,{"initialState":{"artifact":{"artifactType":"ENDPOINT","name":"phi-4-multimodal-instruct","displayName":"phi-4-multimodal-instruct","publisher":"microsoft","shortDescription":"Cutting-edge open multimodal model exceling in high-quality reasoning from image and audio inputs.","logo":"https://assets.ngc.nvidia.com/products/api-catalog/images/phi-4-multimodal-instruct.jpg","labels":["Chart and Table Understanding","Language Generation","Speech Recognition","Visual QA","cloudPartnerType:endpoint:cloud_partner_type_deepinfra","nimType:endpoint:nim_type_preview","nimType:endpoint:nim_type_upgrade_available","playgroundType:endpoint:playgroundtype_chat","usecase:endpoint:usecase_audio_to_text","usecase:endpoint:usecase_image_to_text","usecase:endpoint:usecase_text_gen"],"attributes":[{"key":"DEPRECATION","value":"07/15/2026"},{"key":"PREVIEW","value":"true"}],"updatedDate":"2025-05-24T01:56:10.269Z","canGuestDownload":true,"createdDate":"2025-02-26T21:16:43.734Z","description":"$4f","isPublic":true,"isReadOnly":true,"orgName":"qc69jvmznzxy"},"specAttributes":"$46:props:spec:attributes","modelPath":"/microsoft/phi-4-multimodal-instruct","openApiSpec":{"openapi":"3.1.0","info":{"title":"NVIDIA NIM API for microsoft/phi-4-multimodal-instruct","description":"The NVIDIA NIM REST API. Please see https://docs.api.nvidia.com/nim/reference/microsoft-phi-4-multimodal-instruct for more details.","version":"1.0.0","termsOfService":"https://nvidia.com/legal/terms-of-use","contact":{"name":"NVIDIA Support","url":"https://help.nvidia.com/"},"license":{"name":"MIT","url":"https://opensource.org/license/mit"}},"servers":[{"url":"https://integrate.api.nvidia.com/v1"}],"tags":[{"name":"Multimodal API","description":"This API performs inference using multi-modal large language models (MLLMs)."}],"paths":{"/microsoft/phi-4-multimodal-instruct":{"post":{"tags":["Multimodal API"],"summary":"Request response from the model","description":"Invokes inference using the model chat parameters.","operationId":"invokeFunction","requestBody":{"content":{"application/json":{"schema":{"properties":{"messages":{"items":{"properties":{"role":{"allOf":[{"type":"string","enum":["assistant","user"],"title":"Role"}],"description":"The role of the message's author."},"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"properties":{"audio_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"AudioURL"},"type":{"type":"string","enum":["audio_url"],"const":"audio_url","title":"Type"}},"type":"object","required":["audio_url","type"],"title":"NIMLLMChatCompletionContentPartAudio"},{"properties":{"image_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ImageURL"},"type":{"type":"string","enum":["image_url"],"const":"image_url","title":"Type"}},"type":"object","required":["image_url","type"],"title":"NIMLLMChatCompletionContentPartImage"},{"properties":{"text":{"type":"string","title":"Text"},"type":{"type":"string","enum":["text"],"const":"text","title":"Type"}},"type":"object","required":["text","type"],"title":"NIMLLMChatCompletionContentPartText"}]},"type":"array"}],"title":"Content","description":"The contents of the message.\n
To pass media (only with role=`user`):\n
- Use content parts. Text is passed with `type`=`text`.\n
- Images are passed with `type`=`image_url`; set `image_url.url` to an image URL or a base64 data URI like `data:image/{format};base64,{base64encodedimage}`.\n
- Audio is passed with `type`=`audio_url` or `type`=`input_audio`; set `audio_url.url` to an audio URL or a base64 data URI, or set `input_audio.data` to base64 audio data.\n
For `system` and `assistant` roles, the object list format is not supported.\n"}},"type":"object","required":["role","content"],"title":"NIMLLMChatCompletionMessage"},"type":"array","minItems":1,"title":"Messages","description":"A list of messages comprising the conversation so far."},"model":{"type":"string","title":"Model","description":"The model to use.","default":"microsoft/phi-4-multimodal-instruct"},"frequency_penalty":{"anyOf":[{"type":"number","maximum":2,"minimum":-2},{"type":"null"}],"title":"Frequency Penalty","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.","default":0},"max_tokens":{"anyOf":[{"type":"integer","maximum":8192,"minimum":1},{"type":"null"}],"title":"Max Tokens","description":"The maximum number of tokens that can be generated.","default":512},"presence_penalty":{"anyOf":[{"type":"number","maximum":2,"minimum":-2},{"type":"null"}],"title":"Presence Penalty","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.","default":0},"seed":{"anyOf":[{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000},{"type":"null"}],"title":"Seed","description":"Changing the seed will produce a different response with similar characteristics. Fixing the seed will reproduce the same results if all other parameters are also kept constant."},"stop":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Stop","description":"Sequences where the API will stop generating further tokens."},"stream":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stream","description":"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]`","default":false},"temperature":{"anyOf":[{"type":"number","maximum":2,"minimum":0},{"type":"null"}],"title":"Temperature","description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.","default":0.1},"top_p":{"anyOf":[{"type":"number","maximum":1,"exclusiveMinimum":0},{"type":"null"}],"title":"Top P","description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.","default":0.7}},"additionalProperties":false,"type":"object","required":["messages","model"],"title":"NIMLLMChatCompletionRequest"}}},"required":true},"responses":{"200":{"description":"Invocation is fulfilled","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","enum":["chat.completion"],"const":"chat.completion","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"choices":{"items":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"properties":{"role":{"type":"string","title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","required":["role"],"title":"ChatMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","message"],"title":"ChatCompletionResponseChoice"},"type":"array","title":"Choices"},"usage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","default":0},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","default":0}},"additionalProperties":false,"type":"object","title":"UsageInfo"}},"additionalProperties":false,"type":"object","required":["model","choices","usage"],"title":"ChatCompletionResponse"}},"text/event-stream":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","enum":["chat.completion.chunk"],"const":"chat.completion.chunk","title":"Object","default":"chat.completion.chunk"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"choices":{"items":{"properties":{"index":{"type":"integer","title":"Index"},"delta":{"properties":{"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","title":"DeltaMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","delta"],"title":"ChatCompletionResponseStreamChoice"},"type":"array","title":"Choices"},"usage":{"anyOf":[{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","default":0},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","default":0}},"additionalProperties":false,"type":"object","title":"UsageInfo"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["model","choices"],"title":"ChatCompletionStreamResponse"}}}},"202":{"description":"Result is pending. Client should poll using the requestId.","content":{"application/json":{"example":{},"schema":{}}},"headers":{"NVCF-REQID":{"description":"requestId required for pooling","schema":{"type":"string","format":"uuid","maxLength":36}},"NVCF-STATUS":{"description":"Invocation status","schema":{"type":"string","format":"^[a-zA-Z-]{1,64}$","maxLength":64}}}},"422":{"description":"Validation failed, provided entity could not be processed.","content":{"application/json":{"schema":{"properties":{"object":{"type":"string","title":"Object","default":"error"},"message":{"type":"string","title":"Message"},"type":{"type":"string","title":"Type"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"},"code":{"type":"integer","title":"Code"}},"additionalProperties":false,"type":"object","required":["message","type","code"],"title":"ErrorResponse"},"example":{"type":"urn:nvcf-worker-service:problem-details:unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"string","instance":"/v2/nvcf/pexec/functions/e598bfc1-b058-41af-869d-556d3c7e1b48","requestId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"500":{"description":"The invocation ended with an error.","content":{"application/json":{"schema":{"properties":{"object":{"type":"string","title":"Object","default":"error"},"message":{"type":"string","title":"Message"},"type":{"type":"string","title":"Type"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"},"code":{"type":"integer","title":"Code"}},"additionalProperties":false,"type":"object","required":["message","type","code"],"title":"ErrorResponse"},"example":{"type":"urn:nvcf-worker-service:problem-details:internal-server-error","title":"Internal Server Error","status":500,"detail":"string","instance":"/v2/nvcf/pexec/functions/e598bfc1-b058-41af-869d-556d3c7e1b48","requestId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}}},"x-nvai-meta":{"name":"Create chat completion","returns":"Returns a [chat completion](/docs/api-reference/chat/object) object, or a streamed sequence of [chat completion chunk](/docs/api-reference/chat/streaming) objects if the request is streamed.\n","path":"create","examples":[{"name":"image_captioning","input":{"text":"Describe this image.","images":["https://assets.ngc.nvidia.com/products/api-catalog/phi-4-mini-mm/traffic_sign.jpg"]}},{"name":"multi_image_comparison","input":{"text":"What are common about these two images?","images":["https://assets.ngc.nvidia.com/products/api-catalog/phi-4-mini-mm/cats.jpeg","https://assets.ngc.nvidia.com/products/api-catalog/phi-4-mini-mm/dogs.jpeg"]}},{"name":"speech_recognition","input":{"text":"Transcribe the spoken content.","audios":["https://assets.ngc.nvidia.com/products/api-catalog/phi-4-mini-mm/what_is_the_traffic_sign_in_the_image.wav"]}},{"name":"audio_visual_understanding","input":{"text":"","audios":["https://assets.ngc.nvidia.com/products/api-catalog/phi-4-mini-mm/what_is_the_traffic_sign_in_the_image.wav"],"images":["https://assets.ngc.nvidia.com/products/api-catalog/phi-4-mini-mm/traffic_sign.jpg"]}}],"templates":[{"title":"Default","response":"{\n \"choices\": [{\n \"index\": 0,\n \"model\": \"microsoft/phi-4-multimodal-instruct\",\n \"message\": {\n \"role\": \"assistant\",\n \"content\": \"...\",\n },\n \"finish_reason\": \"stop\"\n }],\n \"usage\": {\n \"prompt_tokens\": 9,\n \"completion_tokens\": 12,\n \"total_tokens\": 21\n }\n}\n","requestEjs":{"python":"$50","langChain":"$51","node.js":"$52","curl":"$53"}}]}}},"/status/{requestId}":{"get":{"tags":["Multimodal API"],"summary":"Gets the result of an earlier function invocation request that returned a status of 202.","operationId":"getFunctionInvocationResult","parameters":[{"name":"requestId","in":"path","description":"requestId to poll results","required":true,"schema":{"type":"string","format":"uuid","maxLength":36}}],"responses":{"200":{"description":"Invocation is fulfilled","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","enum":["chat.completion"],"const":"chat.completion","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"choices":{"items":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"properties":{"role":{"type":"string","title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","required":["role"],"title":"ChatMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","message"],"title":"ChatCompletionResponseChoice"},"type":"array","title":"Choices"},"usage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","default":0},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","default":0}},"additionalProperties":false,"type":"object","title":"UsageInfo"}},"additionalProperties":false,"type":"object","required":["model","choices","usage"],"title":"ChatCompletionResponse"}}}},"202":{"description":"Result is pending. Client should poll using the requestId.","content":{"application/json":{"example":{},"schema":{}}},"headers":{"NVCF-REQID":{"description":"requestId required for pooling","schema":{"type":"string","format":"uuid","maxLength":36}},"NVCF-STATUS":{"description":"Invocation status","schema":{"type":"string","format":"^[a-zA-Z-]{1,64}$","maxLength":64}}}},"422":{"description":"The invocation ended with an error.","content":{"application/json":{"schema":{"properties":{"object":{"type":"string","title":"Object","default":"error"},"message":{"type":"string","title":"Message"},"type":{"type":"string","title":"Type"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"},"code":{"type":"integer","title":"Code"}},"additionalProperties":false,"type":"object","required":["message","type","code"],"title":"ErrorResponse"},"example":{"type":"urn:nvcf-worker-service:problem-details:unprocessable-entity","title":"Unprocessable Entity","status":422,"detail":"string","instance":"/v2/nvcf/pexec/functions/e598bfc1-b058-41af-869d-556d3c7e1b48","requestId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"500":{"description":"The invocation ended with an error.","content":{"application/json":{"schema":{"properties":{"object":{"type":"string","title":"Object","default":"error"},"message":{"type":"string","title":"Message"},"type":{"type":"string","title":"Type"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"},"code":{"type":"integer","title":"Code"}},"additionalProperties":false,"type":"object","required":["message","type","code"],"title":"ErrorResponse"},"example":{"type":"urn:nvcf-worker-service:problem-details:internal-server-error","title":"Internal Server Error","status":500,"detail":"string","instance":"/v2/nvcf/pexec/functions/e598bfc1-b058-41af-869d-556d3c7e1b48","requestId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}}}}}},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"http","scheme":"bearer"}},"schemas":{"ChatCompletionResponse":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","enum":["chat.completion"],"const":"chat.completion","title":"Object","default":"chat.completion"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"choices":{"items":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"properties":{"role":{"type":"string","title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","required":["role"],"title":"ChatMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","message"],"title":"ChatCompletionResponseChoice"},"type":"array","title":"Choices"},"usage":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","default":0},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","default":0}},"additionalProperties":false,"type":"object","title":"UsageInfo"}},"additionalProperties":false,"type":"object","required":["model","choices","usage"],"title":"ChatCompletionResponse"},"ChatCompletionResponseChoice":{"properties":{"index":{"type":"integer","title":"Index"},"message":{"properties":{"role":{"type":"string","title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","required":["role"],"title":"ChatMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","message"],"title":"ChatCompletionResponseChoice"},"ChatCompletionResponseStreamChoice":{"properties":{"index":{"type":"integer","title":"Index"},"delta":{"properties":{"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","title":"DeltaMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","delta"],"title":"ChatCompletionResponseStreamChoice"},"ChatCompletionStreamResponse":{"properties":{"id":{"type":"string","title":"Id"},"object":{"type":"string","enum":["chat.completion.chunk"],"const":"chat.completion.chunk","title":"Object","default":"chat.completion.chunk"},"created":{"type":"integer","title":"Created"},"model":{"type":"string","title":"Model"},"choices":{"items":{"properties":{"index":{"type":"integer","title":"Index"},"delta":{"properties":{"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","title":"DeltaMessage"},"finish_reason":{"anyOf":[{"type":"string","enum":["stop","length"]},{"type":"null"}],"title":"Finish Reason"},"stop_reason":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"title":"Stop Reason"}},"additionalProperties":false,"type":"object","required":["index","delta"],"title":"ChatCompletionResponseStreamChoice"},"type":"array","title":"Choices"},"usage":{"anyOf":[{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","default":0},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","default":0}},"additionalProperties":false,"type":"object","title":"UsageInfo"},{"type":"null"}]}},"additionalProperties":false,"type":"object","required":["model","choices"],"title":"ChatCompletionStreamResponse"},"ChatMessage":{"properties":{"role":{"type":"string","title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","required":["role"],"title":"ChatMessage"},"DeltaMessage":{"properties":{"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"}},"additionalProperties":false,"type":"object","title":"DeltaMessage"},"ErrorResponse":{"properties":{"object":{"type":"string","title":"Object","default":"error"},"message":{"type":"string","title":"Message"},"type":{"type":"string","title":"Type"},"param":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Param"},"code":{"type":"integer","title":"Code"}},"additionalProperties":false,"type":"object","required":["message","type","code"],"title":"ErrorResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"AudioURL":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"AudioURL"},"InputAudio":{"properties":{"data":{"type":"string","title":"Data"},"format":{"type":"string","enum":["wav","mp3"],"title":"Format"}},"type":"object","required":["data","format"],"title":"InputAudio"},"ImageURL":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ImageURL"},"NIMLLMChatCompletionMessage":{"properties":{"role":{"allOf":[{"type":"string","enum":["assistant","user"],"title":"Role"}],"description":"The role of the message's author."},"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"properties":{"audio_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"AudioURL"},"type":{"type":"string","enum":["audio_url"],"const":"audio_url","title":"Type"}},"type":"object","required":["audio_url","type"],"title":"NIMLLMChatCompletionContentPartAudio"},{"properties":{"image_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ImageURL"},"type":{"type":"string","enum":["image_url"],"const":"image_url","title":"Type"}},"type":"object","required":["image_url","type"],"title":"NIMLLMChatCompletionContentPartImage"},{"properties":{"text":{"type":"string","title":"Text"},"type":{"type":"string","enum":["text"],"const":"text","title":"Type"}},"type":"object","required":["text","type"],"title":"NIMLLMChatCompletionContentPartText"}]},"type":"array"}],"title":"Content","description":"The contents of the message.\n
To pass media (only with role=`user`):\n
- Use content parts. Text is passed with `type`=`text`.\n
- Images are passed with `type`=`image_url`; set `image_url.url` to an image URL or a base64 data URI like `data:image/{format};base64,{base64encodedimage}`.\n
- Audio is passed with `type`=`audio_url` or `type`=`input_audio`; set `audio_url.url` to an audio URL or a base64 data URI, or set `input_audio.data` to base64 audio data.\n
For `system` and `assistant` roles, the object list format is not supported.\n"}},"type":"object","required":["role","content"],"title":"NIMLLMChatCompletionMessage"},"NIMLLMChatCompletionRequest":{"properties":{"messages":{"items":{"properties":{"role":{"allOf":[{"type":"string","enum":["assistant","user"],"title":"Role"}],"description":"The role of the message's author."},"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"properties":{"audio_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"AudioURL"},"type":{"type":"string","enum":["audio_url"],"const":"audio_url","title":"Type"}},"type":"object","required":["audio_url","type"],"title":"NIMLLMChatCompletionContentPartAudio"},{"properties":{"image_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ImageURL"},"type":{"type":"string","enum":["image_url"],"const":"image_url","title":"Type"}},"type":"object","required":["image_url","type"],"title":"NIMLLMChatCompletionContentPartImage"},{"properties":{"text":{"type":"string","title":"Text"},"type":{"type":"string","enum":["text"],"const":"text","title":"Type"}},"type":"object","required":["text","type"],"title":"NIMLLMChatCompletionContentPartText"}]},"type":"array"}],"title":"Content","description":"The contents of the message.\n
To pass media (only with role=`user`):\n
- Use content parts. Text is passed with `type`=`text`.\n
- Images are passed with `type`=`image_url`; set `image_url.url` to an image URL or a base64 data URI like `data:image/{format};base64,{base64encodedimage}`.\n
- Audio is passed with `type`=`audio_url` or `type`=`input_audio`; set `audio_url.url` to an audio URL or a base64 data URI, or set `input_audio.data` to base64 audio data.\n
For `system` and `assistant` roles, the object list format is not supported.\n"}},"type":"object","required":["role","content"],"title":"NIMLLMChatCompletionMessage"},"type":"array","minItems":1,"title":"Messages","description":"A list of messages comprising the conversation so far."},"model":{"type":"string","title":"Model","description":"The model to use.","default":"microsoft/phi-4-multimodal-instruct"},"frequency_penalty":{"anyOf":[{"type":"number","maximum":2,"minimum":-2},{"type":"null"}],"title":"Frequency Penalty","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.","default":0},"max_tokens":{"anyOf":[{"type":"integer","maximum":8192,"minimum":1},{"type":"null"}],"title":"Max Tokens","description":"The maximum number of tokens that can be generated.","default":512},"presence_penalty":{"anyOf":[{"type":"number","maximum":2,"minimum":-2},{"type":"null"}],"title":"Presence Penalty","description":"Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.","default":0},"seed":{"anyOf":[{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000},{"type":"null"}],"title":"Seed","description":"Changing the seed will produce a different response with similar characteristics. Fixing the seed will reproduce the same results if all other parameters are also kept constant."},"stop":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Stop","description":"Sequences where the API will stop generating further tokens."},"stream":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Stream","description":"If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]`","default":false},"temperature":{"anyOf":[{"type":"number","maximum":2,"minimum":0},{"type":"null"}],"title":"Temperature","description":"What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.","default":0.1},"top_p":{"anyOf":[{"type":"number","maximum":1,"exclusiveMinimum":0},{"type":"null"}],"title":"Top P","description":"An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both.","default":0.7}},"additionalProperties":false,"type":"object","required":["messages","model"],"title":"NIMLLMChatCompletionRequest"},"NIMLLMChatCompletionContentPartAudio":{"properties":{"audio_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"AudioURL"},"type":{"type":"string","enum":["audio_url"],"const":"audio_url","title":"Type"}},"type":"object","required":["audio_url","type"],"title":"NIMLLMChatCompletionContentPartAudio"},"NIMLLMChatCompletionContentPartInputAudio":{"properties":{"input_audio":{"properties":{"data":{"type":"string","title":"Data"},"format":{"type":"string","enum":["wav","mp3"],"title":"Format"}},"type":"object","required":["data","format"],"title":"InputAudio"},"type":{"type":"string","const":"input_audio","title":"Type"}},"type":"object","required":["input_audio","type"],"title":"NIMLLMChatCompletionContentPartInputAudio"},"NIMLLMChatCompletionContentPartImage":{"properties":{"image_url":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"ImageURL"},"type":{"type":"string","enum":["image_url"],"const":"image_url","title":"Type"}},"type":"object","required":["image_url","type"],"title":"NIMLLMChatCompletionContentPartImage"},"NIMLLMChatCompletionContentPartText":{"properties":{"text":{"type":"string","title":"Text"},"type":{"type":"string","enum":["text"],"const":"text","title":"Type"}},"type":"object","required":["text","type"],"title":"NIMLLMChatCompletionContentPartText"},"Role":{"type":"string","enum":["assistant","user"],"title":"Role"},"UsageInfo":{"properties":{"prompt_tokens":{"type":"integer","title":"Prompt Tokens","default":0},"total_tokens":{"type":"integer","title":"Total Tokens","default":0},"completion_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Completion Tokens","default":0}},"additionalProperties":false,"type":"object","title":"UsageInfo"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}},"pageLayout":"v3"},"children":["$L54","$L55","$L56"]}]