Data Frame Workflows for 'Microsoft Foundry'
![[R logo]](figures/logo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘foundryR’ version 0.1.0
Help Pages
-- A --
| as_foundry_schema | Convert an object to a foundryR JSON Schema |
-- B --
| bake.step_foundry_embed | Apply the Foundry embedding step to new data |
-- C --
| codebook_diff | Compare two codebooks |
| codebook_schema_helpers | Codebook schema helpers |
-- F --
| format.foundry_codebook_diff | Compare two codebooks |
| foundry_agent | Run a bounded Responses API tool-calling loop |
| foundry_agents | List Foundry agents |
| foundry_agent_create | Create a Foundry agent |
| foundry_agent_delete | Delete a Foundry agent |
| foundry_agent_get | Retrieve a Foundry agent |
| foundry_agent_message | Describe an agent message for task adherence |
| foundry_agent_reference | Reference a Foundry agent from the Responses API |
| foundry_agent_tool | Describe an agent tool for task adherence |
| foundry_agent_tool_call | Describe an agent tool call for task adherence |
| foundry_agent_versions | List versions of a Foundry agent |
| foundry_agreement | Compute agreement metrics for LLM annotation |
| foundry_batches | List Microsoft Foundry batches |
| foundry_batch_cancel | Cancel a Microsoft Foundry batch |
| foundry_batch_create | Create a Microsoft Foundry batch |
| foundry_batch_get | Retrieve a Microsoft Foundry batch |
| foundry_batch_requests | Write JSONL requests for the Batch API |
| foundry_batch_results | Parse completed Microsoft Foundry batch results |
| foundry_batch_wait | Wait for a Microsoft Foundry batch to finish |
| foundry_blocklists | Manage Content Safety text blocklists |
| foundry_blocklist_add_items | Manage Content Safety text blocklists |
| foundry_blocklist_create | Manage Content Safety text blocklists |
| foundry_blocklist_delete | Manage Content Safety text blocklists |
| foundry_blocklist_get | Manage Content Safety text blocklists |
| foundry_blocklist_items | Manage Content Safety text blocklists |
| foundry_blocklist_remove_items | Manage Content Safety text blocklists |
| foundry_cache_clear | Clear the foundryR embedding cache |
| foundry_chat | Chat with an Azure AI Model |
| foundry_check_setup | Check foundryR Setup |
| foundry_codebook | Create a measurement codebook |
| foundry_consistency | Measure repeated-extraction consistency |
| foundry_conversations | Manage Responses API conversations |
| foundry_conversation_create | Manage Responses API conversations |
| foundry_conversation_delete | Manage Responses API conversations |
| foundry_conversation_get | Manage Responses API conversations |
| foundry_conversation_items | Manage Responses API conversations |
| foundry_conversation_items_add | Manage Responses API conversations |
| foundry_conversation_update | Manage Responses API conversations |
| foundry_embed | Generate Text Embeddings |
| foundry_embed_batch | Generate Text Embeddings in Parallel Batches |
| foundry_evals | List evaluations |
| foundry_eval_create | Create an evaluation |
| foundry_eval_data_config | Define an evaluation data-source configuration |
| foundry_eval_delete | Delete an evaluation |
| foundry_eval_get | Retrieve an evaluation |
| foundry_eval_item | Build an evaluation item for model-based graders |
| foundry_eval_runs | List evaluation runs |
| foundry_eval_run_cancel | Cancel an evaluation run |
| foundry_eval_run_create | Create an evaluation run |
| foundry_eval_run_data | Define an evaluation run data source |
| foundry_eval_run_get | Retrieve an evaluation run |
| foundry_eval_run_output_items | List evaluation run output items |
| foundry_extract | Extract structured data from text using JSON Schema |
| foundry_extract_batch | Extract structured data with the Batch API |
| foundry_files | List uploaded Microsoft Foundry files |
| foundry_file_delete | Delete a Microsoft Foundry file |
| foundry_file_download | Download Microsoft Foundry file content |
| foundry_file_get | Retrieve a Microsoft Foundry file |
| foundry_file_upload | Upload a file to Microsoft Foundry |
| foundry_get_endpoint | Get Azure AI Foundry Endpoint |
| foundry_get_project_endpoint | Get Azure AI Foundry project endpoint |
| foundry_grader_azure_ai | Azure AI built-in evaluator grader |
| foundry_grader_label_model | Label-model grader |
| foundry_grader_score_model | Score-model grader |
| foundry_grader_string_check | String-check grader |
| foundry_grader_text_similarity | Text-similarity grader |
| foundry_groundedness | Detect Groundedness of LLM Responses |
| foundry_image | Generate Images with DALL-E |
| foundry_image_edit | Edit an image with Microsoft Foundry |
| foundry_llm_resource | Describe a bring-your-own Azure OpenAI resource for groundedness |
| foundry_models | List or retrieve available model deployments |
| foundry_moderate | Moderate Text Content |
| foundry_moderate_image | Moderate image content |
| foundry_moderate_multimodal | Moderate an image together with its text |
| foundry_protected_code | Detect protected material in code |
| foundry_protected_material | Detect protected material in text |
| foundry_provenance | Capture model and schema provenance |
| foundry_response | Create a response with the Azure OpenAI Responses API |
| foundry_response_cancel | Cancel a background Responses API response |
| foundry_response_delete | Delete a stored Responses API response |
| foundry_response_input_items | List input items for a Responses API response |
| foundry_response_retrieve | Retrieve a stored Responses API response |
| foundry_save_image | Save Generated Image to File |
| foundry_schema | Build a strict JSON Schema object |
| foundry_set_content_safety_endpoint | Set Azure Content Safety Endpoint |
| foundry_set_content_safety_key | Set Azure Content Safety API Key |
| foundry_set_endpoint | Set Azure AI Foundry Endpoint |
| foundry_set_image_endpoint | Set Image Generation Endpoint |
| foundry_set_image_key | Set Image Generation API Key |
| foundry_set_key | Set Azure AI Foundry API Key |
| foundry_set_project_endpoint | Set Azure AI Foundry project endpoint |
| foundry_set_speech_endpoint | Set Microsoft Foundry Speech endpoint |
| foundry_set_speech_key | Set Microsoft Foundry Speech API key |
| foundry_set_token | Set Azure AI Foundry Bearer Token |
| foundry_set_token_provider | Set a Microsoft Entra ID token provider |
| foundry_shield | Shield Prompt from Injection Attacks |
| foundry_similarity | Compute Cosine Similarity Between Embeddings |
| foundry_speak | Generate speech audio from text |
| foundry_task_adherence | Check an agent transcript for task adherence |
| foundry_token_azure_cli | Create an Azure CLI token provider |
| foundry_token_azure_identity | Create a Microsoft Entra ID token provider using AzureAuth |
| foundry_tool | Define an R function as a Responses API tool |
| foundry_tool_file_search | Create a file-search tool definition |
| foundry_transcribe | Transcribe an audio file with Microsoft Foundry |
| foundry_translate_audio | Translate an audio file with Microsoft Foundry |
| foundry_usage | Summarise token usage for foundryR results |
| foundry_vector_search | Manage Azure OpenAI vector stores |
| foundry_vector_stores | Manage Azure OpenAI vector stores |
| foundry_vector_store_create | Manage Azure OpenAI vector stores |
| foundry_vector_store_delete | Manage Azure OpenAI vector stores |
| foundry_vector_store_files | Manage Azure OpenAI vector stores |
| foundry_vector_store_file_add | Manage Azure OpenAI vector stores |
| foundry_vector_store_file_batch | Manage Azure OpenAI vector stores |
| foundry_vector_store_file_remove | Manage Azure OpenAI vector stores |
| foundry_vector_store_get | Manage Azure OpenAI vector stores |
| foundry_vector_store_modify | Manage Azure OpenAI vector stores |
| foundry_video_download | Download Microsoft Foundry generated video content |
| foundry_video_get | Retrieve a Microsoft Foundry video generation |
| foundry_video_jobs | List Microsoft Foundry video generation jobs |
| foundry_video_job_create | Create a Microsoft Foundry video generation job |
| foundry_video_job_delete | Delete a Microsoft Foundry video generation job |
| foundry_video_job_get | Retrieve a Microsoft Foundry video generation job |
| foundry_web_search | Search the web with the Responses API |
-- P --
| prep.step_foundry_embed | Prepare the Foundry embedding step |
| print.foundry_codebook_diff | Compare two codebooks |
| print.step_foundry_embed | Print method for step_foundry_embed |
-- R --
| required_pkgs.step_foundry_embed | Required packages for step_foundry_embed |
-- S --
| schema_array | Schema constructors for structured outputs |
| schema_boolean | Schema constructors for structured outputs |
| schema_constructors | Schema constructors for structured outputs |
| schema_enum | Schema constructors for structured outputs |
| schema_integer | Schema constructors for structured outputs |
| schema_number | Schema constructors for structured outputs |
| schema_object | Schema constructors for structured outputs |
| schema_string | Schema constructors for structured outputs |
| step_foundry_embed | Foundry Embedding Recipe Step |
-- T --
| tidy.step_foundry_embed | Foundry Embedding Recipe Step |
| type_boolean | Codebook schema helpers |
| type_enum | Codebook schema helpers |
| type_number | Codebook schema helpers |
| type_string | Codebook schema helpers |